traverseda
/
cpython
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

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".
This commit is contained in:
Andrew Kuchling 2013-11-22 15:45:02 -05:00
parent e0d641abf2
commit 7a4e2d1751
1 changed files with 3 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
Doc/library/pathlib.rst
View File

@ -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. a :ref:`concrete path <concrete-paths>` for the current platform.
.. note:: .. 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 :term:`provisional basis <provisional package>`. Backwards incompatible
changes (up to and including removal of the package) may occur if deemed changes (up to and including removal of the package) may occur if deemed
necessary by the core developers. necessary by the core developers.
@ -250,7 +250,7 @@ property:
Methods and properties Methods and properties
^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^
Pure paths provide the following methods an properties: Pure paths provide the following methods and properties:
.. data:: PurePath.drive .. data:: PurePath.drive
@ -454,7 +454,7 @@ Pure paths provide the following methods an properties:
.. method:: PurePath.joinpath(*other) .. 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:: the *other* arguments in turn::
>>> PurePosixPath('/etc').joinpath('passwd') >>> 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, Remove this file or symbolic link. If the path points to a directory,
use :func:`Path.rmdir` instead. use :func:`Path.rmdir` instead.