1
0
Fork 0
mirror of https://github.com/mperham/sidekiq.git synced 2022-11-09 13:52:34 -05:00

(docs) YARD annotations (#4563)

- use the Example functionality for syntax highlighting
  - use backticks for code in Markdown
This commit is contained in:
Olle Jonsson 2020-05-13 16:10:51 +02:00 committed by GitHub
parent 460ce53271
commit ebeff59f06
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 9 additions and 7 deletions

View file

@ -6,9 +6,10 @@ module Sidekiq
module Extensions
##
# Adds 'delay', 'delay_for' and `delay_until` methods to ActiveRecord to offload instance method
# execution to Sidekiq. Examples:
# execution to Sidekiq.
#
# User.recent_signups.each { |user| user.delay.mark_as_awesome }
# @example
# User.recent_signups.each { |user| user.delay.mark_as_awesome }
#
# Please note, this is not recommended as this will serialize the entire
# object to Redis. Your Sidekiq jobs should pass IDs, not entire instances.

View file

@ -5,11 +5,12 @@ require "sidekiq/extensions/generic_proxy"
module Sidekiq
module Extensions
##
# Adds 'delay', 'delay_for' and `delay_until` methods to all Classes to offload class method
# execution to Sidekiq. Examples:
# Adds `delay`, `delay_for` and `delay_until` methods to all Classes to offload class method
# execution to Sidekiq.
#
# User.delay.delete_inactive
# Wikipedia.delay.download_changes_for(Date.today)
# @example
# User.delay.delete_inactive
# Wikipedia.delay.download_changes_for(Date.today)
#
class DelayedClass
include Sidekiq::Worker

View file

@ -85,7 +85,7 @@ module Sidekiq
notify(FDSTORE, unset_env)
end
# @param [Boolean] true if the service manager expects watchdog keep-alive
# @return [Boolean] true if the service manager expects watchdog keep-alive
# notification messages to be sent from this process.
#
# If the $WATCHDOG_USEC environment variable is set,