Message381673
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:`. |
|
Date |
User |
Action |
Args |
2020-11-23 15:58:31 | p-ganssle | set | recipients:
+ p-ganssle, ezio.melotti, eric.araujo, docs@python, willingc, mdk |
2020-11-23 15:58:31 | p-ganssle | set | messageid: <1606147111.69.0.159922070788.issue42444@roundup.psfhosted.org> |
2020-11-23 15:58:31 | p-ganssle | link | issue42444 messages |
2020-11-23 15:58:31 | p-ganssle | create | |
|