lib/sidekiq/extensions/action_mailer.rb in sidekiq-6.1.1 vs lib/sidekiq/extensions/action_mailer.rb in sidekiq-6.1.2
- old
+ new
@@ -3,12 +3,13 @@
require "sidekiq/extensions/generic_proxy"
module Sidekiq
module Extensions
##
- # Adds 'delay', 'delay_for' and `delay_until` methods to ActionMailer to offload arbitrary email
- # delivery to Sidekiq. Example:
+ # Adds +delay+, +delay_for+ and +delay_until+ methods to ActionMailer to offload arbitrary email
+ # delivery to Sidekiq.
#
+ # @example
# UserMailer.delay.send_welcome_email(new_user)
# UserMailer.delay_for(5.days).send_welcome_email(new_user)
# UserMailer.delay_until(5.days.from_now).send_welcome_email(new_user)
class DelayedMailer
include Sidekiq::Worker