Added some docs about stop method

Tell about the fact that the stop metod must
return a value which can be evaluated to true if
everything went well.
This commit is contained in:
Olivier Amblet 2010-10-26 19:28:49 +02:00
parent 7bae189eba
commit 20d6938cf6
2 changed files with 4 additions and 1 deletions

View File

@ -125,7 +125,9 @@ lib/guard/guard-name.rb inherit from guard/guard and should overwrite at least o
true true
end 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 def stop
true true
end end

View File

@ -30,6 +30,7 @@ module Guard
true true
end end
# Retrieve a true value if the instance successfuly stopped
def stop def stop
true true
end end