[Python-checkins] [3.10] gh-86610: Use attribute directive in docs for pathlib.PurePath (GH-101114) (#101206)
ambv
webhook-mailer at python.org
Fri Jan 20 17:28:41 EST 2023
https://github.com/python/cpython/commit/6919c36541a141ee6d98d36fda2aa9f2c3b3ac5f
commit: 6919c36541a141ee6d98d36fda2aa9f2c3b3ac5f
branch: 3.10
author: Miss Islington (bot) <31488909+miss-islington at users.noreply.github.com>
committer: ambv <lukasz at langa.pl>
date: 2023-01-20T23:28:35+01:00
summary:
[3.10] gh-86610: Use attribute directive in docs for pathlib.PurePath (GH-101114) (#101206)
(cherry picked from commit 01093b82037fbae83623581294a0f1cf5b4a44b0)
Co-authored-by: Barney Gale <barney.gale at gmail.com>
files:
M Doc/library/pathlib.rst
diff --git a/Doc/library/pathlib.rst b/Doc/library/pathlib.rst
index 881f8d6bee61..ee140e871cb4 100644
--- a/Doc/library/pathlib.rst
+++ b/Doc/library/pathlib.rst
@@ -266,7 +266,7 @@ Accessing individual parts
To access the individual "parts" (components) of a path, use the following
property:
-.. data:: PurePath.parts
+.. attribute:: PurePath.parts
A tuple giving access to the path's various components::
@@ -290,7 +290,7 @@ Methods and properties
Pure paths provide the following methods and properties:
-.. data:: PurePath.drive
+.. attribute:: PurePath.drive
A string representing the drive letter or name, if any::
@@ -306,7 +306,7 @@ Pure paths provide the following methods and properties:
>>> PureWindowsPath('//host/share/foo.txt').drive
'\\\\host\\share'
-.. data:: PurePath.root
+.. attribute:: PurePath.root
A string representing the (local or global) root, if any::
@@ -342,7 +342,7 @@ Pure paths provide the following methods and properties:
an implementation-defined manner, although more than two leading slashes
shall be treated as a single slash."*
-.. data:: PurePath.anchor
+.. attribute:: PurePath.anchor
The concatenation of the drive and root::
@@ -356,7 +356,7 @@ Pure paths provide the following methods and properties:
'\\\\host\\share\\'
-.. data:: PurePath.parents
+.. attribute:: PurePath.parents
An immutable sequence providing access to the logical ancestors of
the path::
@@ -372,7 +372,7 @@ Pure paths provide the following methods and properties:
.. versionchanged:: 3.10
The parents sequence now supports :term:`slices <slice>` and negative index values.
-.. data:: PurePath.parent
+.. attribute:: PurePath.parent
The logical parent of the path::
@@ -401,7 +401,7 @@ Pure paths provide the following methods and properties:
symlinks and eliminate `".."` components.
-.. data:: PurePath.name
+.. attribute:: PurePath.name
A string representing the final path component, excluding the drive and
root, if any::
@@ -417,7 +417,7 @@ Pure paths provide the following methods and properties:
''
-.. data:: PurePath.suffix
+.. attribute:: PurePath.suffix
The file extension of the final component, if any::
@@ -429,7 +429,7 @@ Pure paths provide the following methods and properties:
''
-.. data:: PurePath.suffixes
+.. attribute:: PurePath.suffixes
A list of the path's file extensions::
@@ -441,7 +441,7 @@ Pure paths provide the following methods and properties:
[]
-.. data:: PurePath.stem
+.. attribute:: PurePath.stem
The final path component, without its suffix::
@@ -1304,11 +1304,11 @@ Below is a table mapping various :mod:`os` functions to their corresponding
:meth:`Path.group`
:func:`os.path.isabs` :meth:`PurePath.is_absolute`
:func:`os.path.join` :func:`PurePath.joinpath`
-:func:`os.path.basename` :data:`PurePath.name`
-:func:`os.path.dirname` :data:`PurePath.parent`
+:func:`os.path.basename` :attr:`PurePath.name`
+:func:`os.path.dirname` :attr:`PurePath.parent`
:func:`os.path.samefile` :meth:`Path.samefile`
-:func:`os.path.splitext` :data:`PurePath.stem` and
- :data:`PurePath.suffix`
+:func:`os.path.splitext` :attr:`PurePath.stem` and
+ :attr:`PurePath.suffix`
==================================== ==============================
.. rubric:: Footnotes
More information about the Python-checkins
mailing list