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.

Author p-ganssle
Recipients docs@python, eric.araujo, ezio.melotti, mdk, p-ganssle, willingc
Date 2020-11-23.15:58:31
SpamBayes Score -1.0
Marked as misclassified Yes
Message-id <1606147111.69.0.159922070788.issue42444@roundup.psfhosted.org>
In-reply-to
Content
Currently, it seems that the pathlib module uses `.. data::` to annotate the properties of the PurePath type (e.g. .parts, .drive, .root, etc). See: https://github.com/python/cpython/blob/ff420f0e08a2443339da0df7ace95e14177bac53/Doc/library/pathlib.rst

According to the documentation (https://devguide.python.org/documenting/#information-units), `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:`.
History
Date User Action Args
2020-11-23 15:58:31p-gansslesetrecipients: + p-ganssle, ezio.melotti, eric.araujo, docs@python, willingc, mdk
2020-11-23 15:58:31p-gansslesetmessageid: <1606147111.69.0.159922070788.issue42444@roundup.psfhosted.org>
2020-11-23 15:58:31p-gansslelinkissue42444 messages
2020-11-23 15:58:31p-gansslecreate