Document any_return on the Guard class.

2011-10-11 11:16:11 +02:00 · 2011-10-11 11:16:11 +02:00 · 7383efaf31
commit 7383efaf31
parent f6bea4da59
1 changed files with 4 additions and 0 deletions
--- a/lib/guard/guard.rb
+++ b/lib/guard/guard.rb
@ -26,6 +26,10 @@ module Guard
  # Each Guard should provide a template Guardfile located within the Gem
  # 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`,
  # the Guard::GuardName instance will be removed from the active guards.
  #