From: Barney Gale <barney.gale@gmail.com>
Date: Fri, 22 Mar 2024 19:14:09 +0000 (+0000)
Subject: GH-106747: Document another difference between `glob` and `pathlib`. (#116518)
X-Git-Tag: v3.13.0a6~177
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=72eea512b88f8fd68b7258242c37da963ad87360;p=thirdparty%2FPython%2Fcpython.git

GH-106747: Document another difference between `glob` and `pathlib`. (#116518)

Document that `path.glob()` might return *path*, whereas
`glob.glob(root_dir=path)` will never return an empty string corresponding
to *path*.
---

diff --git a/Doc/library/pathlib.rst b/Doc/library/pathlib.rst
index 3ff2631d73c0..4fba3622b073 100644
--- a/Doc/library/pathlib.rst
+++ b/Doc/library/pathlib.rst
@@ -1682,6 +1682,10 @@ The patterns accepted and results generated by :meth:`Path.glob` and
 5. The values returned from pathlib's ``path.glob()`` and ``path.rglob()``
    include the *path* as a prefix, unlike the results of
    ``glob.glob(root_dir=path)``.
+6. The values returned from pathlib's ``path.glob()`` and ``path.rglob()``
+   may include *path* itself, for example when globbing "``**``", whereas the
+   results of ``glob.glob(root_dir=path)`` never include an empty string that
+   would correspond to *path*.
 
 
 Comparison to the :mod:`os` and :mod:`os.path` modules