diff --git a/README.rdoc b/README.rdoc index 994063d..3179968 100644 --- a/README.rdoc +++ b/README.rdoc @@ -134,7 +134,9 @@ lib/guard/guard-name.rb inherit from guard/guard and should overwrite at least o true end - # Call with Ctrl-C signal (when Guard quit) + # Call with Ctrl-C signal (when Guard quit). + # This method must return a true value + # if everything went well or guard will not stop. def stop true end diff --git a/lib/guard/guard.rb b/lib/guard/guard.rb index 5b55b79..f0c8646 100644 --- a/lib/guard/guard.rb +++ b/lib/guard/guard.rb @@ -30,6 +30,7 @@ module Guard true end + # Retrieve a true value if the instance successfuly stopped def stop true end