Document glob() argument change.

barneygale · May 6, 2024 · d23584d · d23584d
1 parent a861589
commit d23584d
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 2 deletions.
diff --git a/CHANGES.rst b/CHANGES.rst
@@ -8,6 +8,7 @@ Unreleased
   to ``PurePathBase.parser``.
 - Add ``PurePathBase.full_match()``.
 - Revert ``match()`` back to 3.12 behaviour (no recursive wildcards).
+- Replace ``PathBase.glob(follow_symlinks=...)`` with ``recurse_symlinks=...``.
 - Disallow passing ``bytes`` to initialisers.
 - Improve walking and globbing performance.
 - Expand test coverage.

diff --git a/docs/api.rst b/docs/api.rst
@@ -175,8 +175,8 @@ Iterating over directories
    The default implementation of this method immediately raises
    :exc:`UnsupportedOperation`.
 
-.. method:: PathBase.glob(pattern, *, case_sensitive=None, follow_symlinks=None)
-.. method:: PathBase.rglob(pattern, *, case_sensitive=None, follow_symlinks=None)
+.. method:: PathBase.glob(pattern, *, case_sensitive=None, recurse_symlinks=True)
+.. method:: PathBase.rglob(pattern, *, case_sensitive=None, recurse_symlinks=True)
 .. method:: PathBase.walk(top_down=True, on_error=None, follow_symlinks=False)
 
    The default implementations of these methods call :meth:`iterdir` and