From d23584d701f81248f3a6a7baf9e781b11e6183f5 Mon Sep 17 00:00:00 2001 From: barneygale Date: Tue, 7 May 2024 00:19:06 +0100 Subject: [PATCH] Document `glob()` argument change. --- CHANGES.rst | 1 + docs/api.rst | 4 ++-- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/CHANGES.rst b/CHANGES.rst index 0c0754b..bc71ce2 100644 --- 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 index 1a8ec3f..ffe2699 100644 --- 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