Document passed options.

earlonrails · Sep 28, 2011 · 40e033c · 40e033c
1 parent 5d12246
commit 40e033c
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/lib/guard/listener.rb b/lib/guard/listener.rb
@@ -133,6 +133,7 @@ def update_last_event
     #
     # @param [Array<String>] dirs the watched directories
     # @param [Hash] options the listener options
+    # @option options [Symbol] all whether to files in sub directories
     # @return [Array<String>] paths of files that have been modified
     #
     def modified_files(dirs, options = {})
@@ -214,7 +215,8 @@ def exclude_ignored_paths(dirs, ignore_paths = self.ignore_paths)
     # Gets a list of files that are in the modified directories.
     #
     # @param [Array<String>] dirs the list of directories
-    # @option options [Symbol] all whether to include all files
+    # @param [Hash] options the find file option
+    # @option options [Symbol] all whether to files in sub directories
     #
     def potentially_modified_files(dirs, options = {})
       paths = exclude_ignored_paths(dirs)