This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

Title: pathlib.PurePath properties annotated with .. data directive
Type: Stage: patch review
Components: Documentation Versions: Python 3.10
Status: open Resolution:
Dependencies: Superseder:
Assigned To: docs@python Nosy List: ZackerySpytz, docs@python, eric.araujo, ezio.melotti, mdk, p-ganssle, willingc
Priority: low Keywords: patch

Created on 2020-11-23 15:58 by p-ganssle, last changed 2022-04-11 14:59 by admin.

Pull Requests
URL Status Linked Edit
PR 24977 open ZackerySpytz, 2021-03-22 17:53
Messages (1)
msg381673 - (view) Author: Paul Ganssle (p-ganssle) * (Python committer) Date: 2020-11-23 15:58
Currently, it seems that the pathlib module uses `.. data::` to annotate the properties of the PurePath type (e.g. .parts, .drive, .root, etc). See:

According to the documentation (, `data` is for module-level constants, specifically:

> Describes global data in a module, including both variables and values used
> as “defined constants.” Class and object attributes are not documented using
> this directive.

I believe that we should switch these over to use the `.. attribute:` directive instead.

From what I can tell, you can still link to these attributes using the `:attr:` role. I haven't checked if you can link to `:attribute:`s using the `:data:` role, though. If not, it might break some links to change these to `:attribute:`.
Date User Action Args
2022-04-11 14:59:38adminsetgithub: 86610
2021-03-22 17:53:20ZackerySpytzsetkeywords: + patch
nosy: + ZackerySpytz

pull_requests: + pull_request23736
stage: patch review
2020-11-23 15:58:31p-gansslecreate