Permalink
Browse files

added inline doc for template method

  • Loading branch information...
schmurfy committed Dec 1, 2012
1 parent 00fbc16 commit 1a5e714693c486161c6bfdbeb4ec316ac3a40b82
Showing with 5 additions and 1 deletion.
  1. +5 −1 lib/guard/guard.rb
View
@@ -58,7 +58,11 @@ def initialize(watchers = [], options = {})
@watchers, @options = watchers, options
end
-
+ # Specify the source for the Guardfile template.
+ # Each Guard plugin can redefine this method to add its own logic.
+ #
+ # @param [String] The plugin name
+ #
def self.template(name)
File.read("#{ ::Guard.locate_guard(name) }/lib/guard/#{ name }/templates/Guardfile")
end

0 comments on commit 1a5e714

Please sign in to comment.