From: Jürgen Gmach <juergen.gmach@googlemail.com>
Date: Fri, 20 Jan 2023 22:11:31 +0000 (+0100)
Subject: GH-101112: Specify type of pattern for Path.rglob (#101132)
X-Git-Tag: v3.12.0a5~143
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=61f338a005aa9f36b2a0a8d6924857e703bb6140;p=thirdparty%2FPython%2Fcpython.git

GH-101112: Specify type of pattern for Path.rglob (#101132)

The documentation for `rglob` did not mention what `pattern` actually
is.

Mentioning and linking to `fnmatch` makes this explicit, as the
documentation for `fnmatch` both shows the syntax and some explanation.
---

diff --git a/Doc/library/pathlib.rst b/Doc/library/pathlib.rst
index c5cf409f5f1f..42d63b1a8f09 100644
--- a/Doc/library/pathlib.rst
+++ b/Doc/library/pathlib.rst
@@ -1270,7 +1270,8 @@ call fails (for example because the path doesn't exist).
 .. method:: Path.rglob(pattern)
 
    Glob the given relative *pattern* recursively.  This is like calling
-   :func:`Path.glob` with "``**/``" added in front of the *pattern*::
+   :func:`Path.glob` with "``**/``" added in front of the *pattern*, where
+   *patterns* are the same as for :mod:`fnmatch`::
 
       >>> sorted(Path().rglob("*.py"))
       [PosixPath('build/lib/pathlib.py'),