[3.7] bpo-22062: Updated docstring and documentation for pathlib (GH-8519) (GH-11817)
Original patch by Mike Short
https://bugs.python.org/issue22062
(cherry picked from commit 537b6caa565ec2fc304ba6f4400cd347ce2af64b)
Co-authored-by: Eivind Teig <eivind.teig@gmail.com>
https://bugs.python.org/issue22062
diff --git a/Doc/library/pathlib.rst b/Doc/library/pathlib.rst
index b4ae293..7d4b41b 100644
--- a/Doc/library/pathlib.rst
+++ b/Doc/library/pathlib.rst
@@ -718,7 +718,7 @@
.. method:: Path.glob(pattern)
- Glob the given *pattern* in the directory represented by this path,
+ Glob the given relative *pattern* in the directory represented by this path,
yielding all matching files (of any kind)::
>>> sorted(Path('.').glob('*.py'))
@@ -970,8 +970,8 @@
.. method:: Path.rglob(pattern)
- This is like calling :meth:`Path.glob` with "``**``" added in front of the
- given *pattern*::
+ This is like calling :func:`Path.glob` with "``**/``" added in front of the
+ given relative *pattern*::
>>> sorted(Path().rglob("*.py"))
[PosixPath('build/lib/pathlib.py'),
diff --git a/Lib/pathlib.py b/Lib/pathlib.py
index 067edf1..dd6a83f 100644
--- a/Lib/pathlib.py
+++ b/Lib/pathlib.py
@@ -1090,7 +1090,7 @@
def glob(self, pattern):
"""Iterate over this subtree and yield all existing files (of any
- kind, including directories) matching the given pattern.
+ kind, including directories) matching the given relative pattern.
"""
if not pattern:
raise ValueError("Unacceptable pattern: {!r}".format(pattern))
@@ -1104,7 +1104,8 @@
def rglob(self, pattern):
"""Recursively yield all existing files (of any kind, including
- directories) matching the given pattern, anywhere in this subtree.
+ directories) matching the given relative pattern, anywhere in
+ this subtree.
"""
pattern = self._flavour.casefold(pattern)
drv, root, pattern_parts = self._flavour.parse_parts((pattern,))
diff --git a/Misc/NEWS.d/next/Documentation/2018-07-28-12-41-01.bpo-22062.TaN2hn.rst b/Misc/NEWS.d/next/Documentation/2018-07-28-12-41-01.bpo-22062.TaN2hn.rst
new file mode 100644
index 0000000..cb47fe1
--- /dev/null
+++ b/Misc/NEWS.d/next/Documentation/2018-07-28-12-41-01.bpo-22062.TaN2hn.rst
@@ -0,0 +1 @@
+Update documentation and docstrings for pathlib. Original patch by Mike Short.