From 7383efaf318af07a9e66c2fdf1329a3357ae43ba Mon Sep 17 00:00:00 2001 From: Michael Kessler Date: Tue, 11 Oct 2011 11:16:11 +0200 Subject: [PATCH] Document any_return on the Guard class. --- lib/guard/guard.rb | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/lib/guard/guard.rb b/lib/guard/guard.rb index 1187348..43e5737 100644 --- 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. #