Document that fileutils.iter_find_files works recursively on the spec…

…ified directory
mahmoud · Dec 23, 2018 · 8d652d0 · 8d652d0
1 parent 6621cb4
commit 8d652d0
Showing 1 changed file with 3 additions and 3 deletions.
diff --git a/boltons/fileutils.py b/boltons/fileutils.py
@@ -455,9 +455,9 @@ def __exit__(self, exc_type, exc_val, exc_tb):
 
 
 def iter_find_files(directory, patterns, ignored=None):
-    """Returns a generator that yields file paths under a *directory*,
-    matching *patterns* using `glob`_ syntax (e.g., ``*.txt``). Also
-    supports *ignored* patterns.
+    """Returns a generator that yields file paths under a *directory*
+    (recursively), matching *patterns* using `glob`_ syntax (e.g., ``*.txt``).
+    Also supports *ignored* patterns.
 
     Args:
         directory (str): Path that serves as the root of the