github-migration/master
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Tiny doc improvements

Browse Source
This commit is contained in:
Rémy Coutable 2011-09-20 21:52:59 +02:00
parent c0dcef9dbc
commit d493e3c5d9
4 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
lib/guard.rb
View File

@ -140,7 +140,7 @@ module Guard
# Let a Guard execute its task, but fire it # Let a Guard execute its task, but fire it
# if his work leads to a system failure. # 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 [Symbol] task_to_supervise the task to run
# @param [Array] args the arguments for the task # @param [Array] args the arguments for the task
# @return [Boolean, Exception] the result of the Guard # @return [Boolean, Exception] the result of the Guard
@ -166,7 +166,7 @@ module Guard
# @param [String] name the Guard name # @param [String] name the Guard name
# @param [Array<Watcher>] watchers the list of declared watchers # @param [Array<Watcher>] watchers the list of declared watchers
# @param [Array<Hash>] callbacks the list of callbacks # @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 = {}) def add_guard(name, watchers = [], callbacks = [], options = {})
if name.to_sym == :ego if name.to_sym == :ego

2
lib/guard/dsl.rb
View File

@ -342,7 +342,7 @@ module Guard
# Ignore certain paths globally. # Ignore certain paths globally.
# #
# @example Ignore some paths # @example Ignore some paths
# ignore_paths .git, .svn # ignore_paths ".git", ".svn"
# #
# @param [Array] paths the list of paths to ignore # @param [Array] paths the list of paths to ignore
# #

2
lib/guard/dsl_describer.rb
View File

@ -6,7 +6,7 @@ module Guard
# of the Guardfile that is used in some inspection utility methods # of the Guardfile that is used in some inspection utility methods
# like the CLI commands `show` and `list`. # like the CLI commands `show` and `list`.
# #
# @see Guard::DSL # @see Guard::Dsl
# @see Guard::CLI # @see Guard::CLI
# #
class DslDescriber < Dsl class DslDescriber < Dsl

4
lib/guard/ui.rb
View File

@ -46,13 +46,13 @@ module Guard
end end
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 [String] message the message to show
# @param [Hash] options the options # @param [Hash] options the options
# @option options [Boolean] reset whether to clean the output before # @option options [Boolean] reset whether to clean the output before
# #
def debug(message, options={ }) def debug(message, options = { })
unless ENV['GUARD_ENV'] == 'test' unless ENV['GUARD_ENV'] == 'test'
reset_line if options[:reset] reset_line if options[:reset]
puts color("DEBUG (#{Time.now.strftime('%T')}): ", :yellow) + message if ::Guard.options && ::Guard.options[:debug] puts color("DEBUG (#{Time.now.strftime('%T')}): ", :yellow) + message if ::Guard.options && ::Guard.options[:debug]