diff options
| author | Eivind Teig <eivind.teig@gmail.com> | 2019-02-11 10:47:09 (GMT) |
|---|---|---|
| committer | Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com> | 2019-02-11 10:47:09 (GMT) |
| commit | 537b6caa565ec2fc304ba6f4400cd347ce2af64b (patch) | |
| tree | 2a9d75955d62435a872e1540ea77ec0ed222dc1c | |
| parent | 9db56fb8faaa3cd66e7fe82740a4ae4d786bb27f (diff) | |
| download | cpython-537b6caa565ec2fc304ba6f4400cd347ce2af64b.zip cpython-537b6caa565ec2fc304ba6f4400cd347ce2af64b.tar.gz cpython-537b6caa565ec2fc304ba6f4400cd347ce2af64b.tar.bz2 | |
bpo-22062: Updated docstring and documentation for pathlib (GH-8519)
Original patch by Mike Short
https://bugs.python.org/issue22062
| -rw-r--r-- | Doc/library/pathlib.rst | 6 | ||||
| -rw-r--r-- | Lib/pathlib.py | 5 | ||||
| -rw-r--r-- | Misc/NEWS.d/next/Documentation/2018-07-28-12-41-01.bpo-22062.TaN2hn.rst | 1 |
3 files changed, 7 insertions, 5 deletions
diff --git a/Doc/library/pathlib.rst b/Doc/library/pathlib.rst index 6aebe97..450e8ff 100644 --- a/Doc/library/pathlib.rst +++ b/Doc/library/pathlib.rst @@ -728,7 +728,7 @@ call fails (for example because the path doesn't exist). .. 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')) @@ -980,8 +980,8 @@ call fails (for example because the path doesn't exist). .. 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 da32f90..911b774 100644 --- a/Lib/pathlib.py +++ b/Lib/pathlib.py @@ -1090,7 +1090,7 @@ class Path(PurePath): 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 @@ class Path(PurePath): 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. |