diff options
author | Andrew Kuchling <amk@amk.ca> | 2013-11-22 20:45:02 (GMT) |
---|---|---|
committer | Andrew Kuchling <amk@amk.ca> | 2013-11-22 20:45:02 (GMT) |
commit | 7a4e2d1751e7b261cd13685d488504e6d5a7ebee (patch) | |
tree | c454f9689cc1f3050110e97e75f4f0ffc995a7a8 | |
parent | e0d641abf2784360facaebadd2418d1498c380f9 (diff) | |
download | cpython-7a4e2d1751e7b261cd13685d488504e6d5a7ebee.zip cpython-7a4e2d1751e7b261cd13685d488504e6d5a7ebee.tar.gz cpython-7a4e2d1751e7b261cd13685d488504e6d5a7ebee.tar.bz2 |
Wording changes to pathlib docs.
Only possibly-controversial change: joinpath() was described as:
"Calling this method is equivalent to indexing the path with each of
the *other* arguments in turn."
'Indexing' is an odd word to use, because you can't subscript Path or
PurePath objects, so I changed it to "combining".
-rw-r--r-- | Doc/library/pathlib.rst | 7 |
1 files changed, 3 insertions, 4 deletions
diff --git a/Doc/library/pathlib.rst b/Doc/library/pathlib.rst index 04f6c42..7582315 100644 --- a/Doc/library/pathlib.rst +++ b/Doc/library/pathlib.rst @@ -20,7 +20,7 @@ The main point of entry is the :class:`Path` class, which will instantiate a :ref:`concrete path <concrete-paths>` for the current platform. .. note:: - This module module has been included in the standard library on a + This module has been included in the standard library on a :term:`provisional basis <provisional package>`. Backwards incompatible changes (up to and including removal of the package) may occur if deemed necessary by the core developers. @@ -250,7 +250,7 @@ property: Methods and properties ^^^^^^^^^^^^^^^^^^^^^^ -Pure paths provide the following methods an properties: +Pure paths provide the following methods and properties: .. data:: PurePath.drive @@ -454,7 +454,7 @@ Pure paths provide the following methods an properties: .. method:: PurePath.joinpath(*other) - Calling this method is equivalent to indexing the path with each of + Calling this method is equivalent to combining the path with each of the *other* arguments in turn:: >>> PurePosixPath('/etc').joinpath('passwd') @@ -871,4 +871,3 @@ call fails (for example because the path doesn't exist): Remove this file or symbolic link. If the path points to a directory, use :func:`Path.rmdir` instead. - |