Improve documentation for File.glob.

Closes rubyzip#338.
hainesr · Jun 26, 2021 · 8699e35 · 8699e35
1 parent a301d68
commit 8699e35
Showing 1 changed file with 5 additions and 1 deletion.
diff --git a/lib/zip/file.rb b/lib/zip/file.rb
@@ -330,7 +330,11 @@ def find_entry(entry_name)
       selected_entry
     end
 
-    # Searches for entries given a glob
+    # Search for entries given a glob pattern. You can also supply flags
+    # in the second argument, which are equivalent to those used by
+    # `::Dir.glob` and `::File.fnmatch`. Default flags are
+    # `::File::FNM_PATHNAME | ::File::FNM_DOTMATCH | ::File::FNM_EXTGLOB`,
+    # which will be overridden if you set your own flags.
     def glob(*args, &block)
       @entry_set.glob(*args, &block)
     end