aboutsummaryrefslogtreecommitdiffstats
path: root/actionmailer/lib/action_mailer/base.rb
diff options
context:
space:
mode:
authorAbdelkader Boudih <terminale@gmail.com>2014-08-20 16:41:00 +0000
committerAbdelkader Boudih <terminale@gmail.com>2014-08-20 16:41:00 +0000
commit6e75e7e3bc3f0a405dbaca486ecbe5cb00a6d783 (patch)
treecbf952799e099df690424d45de314f3939569b84 /actionmailer/lib/action_mailer/base.rb
parent79bcab79d97239593c8f9500c70226abada341c6 (diff)
downloadrails-6e75e7e3bc3f0a405dbaca486ecbe5cb00a6d783.tar.gz
rails-6e75e7e3bc3f0a405dbaca486ecbe5cb00a6d783.tar.bz2
rails-6e75e7e3bc3f0a405dbaca486ecbe5cb00a6d783.zip
[Rdoc] Make clear that we are sending an AR object [ci skip]
Diffstat (limited to 'actionmailer/lib/action_mailer/base.rb')
-rw-r--r--actionmailer/lib/action_mailer/base.rb8
1 files changed, 4 insertions, 4 deletions
diff --git a/actionmailer/lib/action_mailer/base.rb b/actionmailer/lib/action_mailer/base.rb
index 0e4497536d..ad3aebbe9b 100644
--- a/actionmailer/lib/action_mailer/base.rb
+++ b/actionmailer/lib/action_mailer/base.rb
@@ -138,20 +138,20 @@ module ActionMailer
# Once a mailer action and template are defined, you can deliver your message or create it and save it
# for delivery later:
#
- # Notifier.welcome('david').deliver_now # sends the email
- # mail = Notifier.welcome('david') # => an ActionMailer::MessageDeliver object
+ # Notifier.welcome(User.first).deliver_now # sends the email
+ # mail = Notifier.welcome(User.first) # => an ActionMailer::MessageDeliver object
# mail.deliver_now # sends the email
#
# The <tt>ActionMailer::MessageDeliver</tt> class is a wrapper around a <tt>Mail::Message</tt> object. If
# you want direct access to the <tt>Mail::Message</tt> object you can call the <tt>message</tt> method on
# the <tt>ActionMailer::MessageDeliver</tt> object.
#
- # Notifier.welcome('david').message # => a Mail::Message object
+ # Notifier.welcome(User.first).message # => a Mail::Message object
#
# ActionMailer is nicely integrated with ActiveJob so you can send emails in the background (example: outside
# of the request-response cycle, so the user doesn't have to wait on it):
#
- # Notifier.welcome('david').deliver_later # enqueue the email sending to ActiveJob
+ # Notifier.welcome(User.first).deliver_later # enqueue the email sending to ActiveJob
#
# You never instantiate your mailer class. Rather, you just call the method you defined on the class itself.
#