Tiny doc improvements
This commit is contained in:
parent
c0dcef9dbc
commit
d493e3c5d9
@ -140,7 +140,7 @@ module Guard
|
||||
# Let a Guard execute its task, but fire it
|
||||
# if his work leads to a system failure.
|
||||
#
|
||||
# @param [Guard::Guard] the guard to execute
|
||||
# @param [Guard::Guard] guard the Guard to execute
|
||||
# @param [Symbol] task_to_supervise the task to run
|
||||
# @param [Array] args the arguments for the task
|
||||
# @return [Boolean, Exception] the result of the Guard
|
||||
@ -166,7 +166,7 @@ module Guard
|
||||
# @param [String] name the Guard name
|
||||
# @param [Array<Watcher>] watchers the list of declared watchers
|
||||
# @param [Array<Hash>] callbacks the list of callbacks
|
||||
# @param [Hash] the Guard options
|
||||
# @param [Hash] options the Guard options
|
||||
#
|
||||
def add_guard(name, watchers = [], callbacks = [], options = {})
|
||||
if name.to_sym == :ego
|
||||
|
@ -342,7 +342,7 @@ module Guard
|
||||
# Ignore certain paths globally.
|
||||
#
|
||||
# @example Ignore some paths
|
||||
# ignore_paths .git, .svn
|
||||
# ignore_paths ".git", ".svn"
|
||||
#
|
||||
# @param [Array] paths the list of paths to ignore
|
||||
#
|
||||
|
@ -6,7 +6,7 @@ module Guard
|
||||
# of the Guardfile that is used in some inspection utility methods
|
||||
# like the CLI commands `show` and `list`.
|
||||
#
|
||||
# @see Guard::DSL
|
||||
# @see Guard::Dsl
|
||||
# @see Guard::CLI
|
||||
#
|
||||
class DslDescriber < Dsl
|
||||
|
@ -46,7 +46,7 @@ module Guard
|
||||
end
|
||||
end
|
||||
|
||||
# Show a debug message that is prefixed with DEBUG and a timestampe.
|
||||
# Show a debug message that is prefixed with DEBUG and a timestamp.
|
||||
#
|
||||
# @param [String] message the message to show
|
||||
# @param [Hash] options the options
|
||||
|
Loading…
Reference in New Issue
Block a user