mirror of
https://github.com/mperham/sidekiq.git
synced 2022-11-09 13:52:34 -05:00
Document methods and make documentation uniform for extensions
This commit is contained in:
parent
2851800ed4
commit
ab55338c90
3 changed files with 3 additions and 3 deletions
|
@ -3,7 +3,7 @@ require 'sidekiq/extensions/generic_proxy'
|
||||||
module Sidekiq
|
module Sidekiq
|
||||||
module Extensions
|
module Extensions
|
||||||
##
|
##
|
||||||
# Adds 'delay' and 'delay_for' to ActionMailer to offload arbitrary email
|
# Adds 'delay', 'delay_for' and `delay_until` methods to ActionMailer to offload arbitrary email
|
||||||
# delivery to Sidekiq. Example:
|
# delivery to Sidekiq. Example:
|
||||||
#
|
#
|
||||||
# UserMailer.delay.send_welcome_email(new_user)
|
# UserMailer.delay.send_welcome_email(new_user)
|
||||||
|
|
|
@ -3,7 +3,7 @@ require 'sidekiq/extensions/generic_proxy'
|
||||||
module Sidekiq
|
module Sidekiq
|
||||||
module Extensions
|
module Extensions
|
||||||
##
|
##
|
||||||
# Adds a 'delay' method to ActiveRecords to offload instance method
|
# Adds 'delay', 'delay_for' and `delay_until` methods to ActiveRecord to offload instance method
|
||||||
# execution to Sidekiq. Examples:
|
# execution to Sidekiq. Examples:
|
||||||
#
|
#
|
||||||
# User.recent_signups.each { |user| user.delay.mark_as_awesome }
|
# User.recent_signups.each { |user| user.delay.mark_as_awesome }
|
||||||
|
|
|
@ -3,7 +3,7 @@ require 'sidekiq/extensions/generic_proxy'
|
||||||
module Sidekiq
|
module Sidekiq
|
||||||
module Extensions
|
module Extensions
|
||||||
##
|
##
|
||||||
# Adds a 'delay' method to all Classes to offload class method
|
# Adds 'delay', 'delay_for' and `delay_until` methods to all Classes to offload class method
|
||||||
# execution to Sidekiq. Examples:
|
# execution to Sidekiq. Examples:
|
||||||
#
|
#
|
||||||
# User.delay.delete_inactive
|
# User.delay.delete_inactive
|
||||||
|
|
Loading…
Add table
Reference in a new issue