Skip to content

Commit

Permalink
Tiny documentation styling fixes [ci skip]
Browse files Browse the repository at this point in the history
  • Loading branch information
robin850 committed Nov 2, 2014
1 parent 26126c8 commit 1d6d0cc
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 18 deletions.
37 changes: 21 additions & 16 deletions actionmailer/README.rdoc
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand All @@ -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:

Expand All @@ -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

Expand Down
2 changes: 1 addition & 1 deletion activejob/lib/active_job/queue_adapters.rb
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
# |-------------------|-------|--------|-----------|------------|---------|---------|
Expand Down
3 changes: 2 additions & 1 deletion guides/source/asset_pipeline.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`:

Expand Down

0 comments on commit 1d6d0cc

Please sign in to comment.