Document Base#grep parameters

jcouball · jcouball · commit 60758f36a3e2 · 2023-02-23T16:12:12.000-08:00
Signed-off-by: James Couball &lt;jcouball@yahoo.com&gt;
diff --git a/lib/git/base.rb b/lib/git/base.rb
@@ -209,6 +209,15 @@ def lib
     #     end
     #   end
     #
+    # @param string [String] the string to search for
+    # @param path_limiter [String, Array] a path or array of paths to limit the search to or nil for no limit
+    # @param opts [Hash] options to pass to the underlying `git grep` command
+    #
+    # @option opts [Boolean] :ignore_case (false) ignore case when matching
+    # @option opts [Boolean] :invert_match (false) select non-matching lines
+    # @option opts [Boolean] :extended_regexp (false) use extended regular expressions
+    # @option opts [String] :object (HEAD) the object to search from
+    #
     # @return [Hash<String, Array>] a hash of arrays
     #   ```Ruby
     #   {
