diff options
author | Robin Dupret <robin.dupret@gmail.com> | 2014-11-02 12:32:50 +0100 |
---|---|---|
committer | Robin Dupret <robin.dupret@gmail.com> | 2014-11-02 12:32:50 +0100 |
commit | 1d6d0cc2455f65454f7cb8f938204cddf6380e24 (patch) | |
tree | 2e40f08bca2d70f92e9c1e7355a478dfb34885f1 | |
parent | 26126c85334356e8fab7892dd30b2dc24a28c68e (diff) | |
download | rails-1d6d0cc2455f65454f7cb8f938204cddf6380e24.tar.gz rails-1d6d0cc2455f65454f7cb8f938204cddf6380e24.tar.bz2 rails-1d6d0cc2455f65454f7cb8f938204cddf6380e24.zip |
Tiny documentation styling fixes [ci skip]
-rw-r--r-- | actionmailer/README.rdoc | 37 | ||||
-rw-r--r-- | activejob/lib/active_job/queue_adapters.rb | 2 | ||||
-rw-r--r-- | guides/source/asset_pipeline.md | 3 |
3 files changed, 24 insertions, 18 deletions
diff --git a/actionmailer/README.rdoc b/actionmailer/README.rdoc index b4eb40f54d..a4e660d621 100644 --- a/actionmailer/README.rdoc +++ b/actionmailer/README.rdoc @@ -74,14 +74,17 @@ Or you can just chain the methods together like: == Setting defaults -It is possible to set default values that will be used in every method in your Action Mailer class. -To implement this functionality, you just call the public class method <tt>default</tt> which you get for free from -<tt>ActionMailer::Base</tt>. This method accepts a Hash as the parameter. You can use any of the headers, email messages -have, like <tt>:from</tt> as the key. You can also pass in a string as the key, like "Content-Type", but Action Mailer -does this out of the box for you, so you won't need to worry about that. -Finally, it is also possible to pass in a Proc that will get evaluated when it is needed. - -Note that every value you set with this method will get overwritten if you use the same key in your mailer method. +It is possible to set default values that will be used in every method in your +Action Mailer class. To implement this functionality, you just call the public +class method +default+ which you get for free from <tt>ActionMailer::Base</tt>. +This method accepts a Hash as the parameter. You can use any of the headers, +email messages have, like +:from+ as the key. You can also pass in a string as +the key, like "Content-Type", but Action Mailer does this out of the box for you, +so you won't need to worry about that. Finally, it is also possible to pass in a +Proc that will get evaluated when it is needed. + +Note that every value you set with this method will get overwritten if you use the +same key in your mailer method. Example: @@ -92,10 +95,11 @@ Example: == Receiving emails -To receive emails, you need to implement a public instance method called <tt>receive</tt> that takes an -email object as its single parameter. The Action Mailer framework has a corresponding class method, -which is also called <tt>receive</tt>, that accepts a raw, unprocessed email as a string, which it then turns -into the email object and calls the receive instance method. +To receive emails, you need to implement a public instance method called ++receive+ that takes an email object as its single parameter. The Action Mailer +framework has a corresponding class method, which is also called +receive+, that +accepts a raw, unprocessed email as a string, which it then turns into the email +object and calls the receive instance method. Example: @@ -116,13 +120,14 @@ Example: end end -This Mailman can be the target for Postfix or other MTAs. In Rails, you would use the runner in the -trivial case like this: +This Mailman can be the target for Postfix or other MTAs. In Rails, you would use +the runner in the trivial case like this: rails runner 'Mailman.receive(STDIN.read)' -However, invoking Rails in the runner for each mail to be received is very resource intensive. A single -instance of Rails should be run within a daemon, if it is going to process more than just a limited amount of email. +However, invoking Rails in the runner for each mail to be received is very +resource intensive. A single instance of Rails should be run within a daemon, if +it is going to process more than just a limited amount of email. == Configuration diff --git a/activejob/lib/active_job/queue_adapters.rb b/activejob/lib/active_job/queue_adapters.rb index efbcd3cb3a..f22b0502dc 100644 --- a/activejob/lib/active_job/queue_adapters.rb +++ b/activejob/lib/active_job/queue_adapters.rb @@ -13,7 +13,7 @@ module ActiveJob # * {Sneakers}[https://github.com/jondot/sneakers] # * {Sucker Punch}[https://github.com/brandonhilkert/sucker_punch] # - # #### Backends Features + # === Backends Features # # | | Async | Queues | Delayed | Priorities | Timeout | Retries | # |-------------------|-------|--------|-----------|------------|---------|---------| diff --git a/guides/source/asset_pipeline.md b/guides/source/asset_pipeline.md index e552c3804d..ae0f19c02a 100644 --- a/guides/source/asset_pipeline.md +++ b/guides/source/asset_pipeline.md @@ -1347,7 +1347,8 @@ config.assets.digest = true Rails 4 no longer sets default config values for Sprockets in `test.rb`, so `test.rb` now requires Sprockets configuration. The old defaults in the test -environment are: `config.assets.compile = true`, `config.assets.compress = false`, `config.assets.debug = false` and `config.assets.digest = false`. +environment are: `config.assets.compile = true`, `config.assets.compress = false`, +`config.assets.debug = false` and `config.assets.digest = false`. The following should also be added to `Gemfile`: |