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

Document any_return on the Guard class.

Browse Source
This commit is contained in:
Michael Kessler 2011-10-11 11:16:11 +02:00
parent f6bea4da59
commit 7383efaf31
1 changed files with 4 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
lib/guard/guard.rb
View File

@ -26,6 +26,10 @@ module Guard
# Each Guard should provide a template Guardfile located within the Gem # Each Guard should provide a template Guardfile located within the Gem
# at `lib/guard/guard-name/templates/Guardfile`. # at `lib/guard/guard-name/templates/Guardfile`.
# #
# By default all watchers for a Guard are returning strings of paths to the
# Guard, but if your Guard want to allow any return value from a watcher,
# you can set the `any_return` option to true.
#
# If one of those methods raise an exception other than `:task_has_failed`, # If one of those methods raise an exception other than `:task_has_failed`,
# the Guard::GuardName instance will be removed from the active guards. # the Guard::GuardName instance will be removed from the active guards.
# #