[issue42444] pathlib.PurePath properties annotated with .. data directive

[Paul Ganssle]

New submission from Paul Ganssle <p.ganssle at gmail.com>:

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:`.

----------
assignee: docs at python
components: Documentation
messages: 381673
nosy: docs at python, eric.araujo, ezio.melotti, mdk, p-ganssle, willingc
priority: low
severity: normal
status: open
title: pathlib.PurePath properties annotated with .. data directive
versions: Python 3.10

_______________________________________
Python tracker <report at bugs.python.org>
<https://bugs.python.org/issue42444>
_______________________________________