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.

classification
Title: distutils: cyclic reference in the documentation
Type: Stage: resolved
Components: Documentation Versions: Python 3.8, Python 3.7, Python 3.6, Python 2.7
process
Status: closed Resolution:
Dependencies: Superseder:
Assigned To: docs@python Nosy List: docs@python, matrixise, r.david.murray
Priority: normal Keywords: patch

Created on 2018-02-05 16:35 by matrixise, last changed 2022-04-11 14:58 by admin. This issue is now closed.

Pull Requests
URL Status Linked Edit
PR 5555 closed matrixise, 2018-02-05 16:38
Messages (3)
msg311674 - (view) Author: Stéphane Wirtel (matrixise) * (Python committer) Date: 2018-02-05 16:39
in the documentation of the distutils module, there is a cyclic references, just remove them because I think it's useless.
msg311680 - (view) Author: R. David Murray (r.david.murray) * (Python committer) Date: 2018-02-05 18:12
This is a common pattern in our documentation.  It is done because ":mod:`xxx`" means that xxx should be formatted as a module name, rather than anything else.  While it is true that the formatting for most such references is currently the same, it could be different in principle, and is for a few.  It is in some ways unfortunate that it also always results in a link, so you will indeed find a number of places where the prefix is omitted, mostly commonly when the same entity is referenced several times in the same paragraph.

So, it is not completely clear cut, but I would recommend rejecting this and leaving the docs as is.
msg311681 - (view) Author: Stéphane Wirtel (matrixise) * (Python committer) Date: 2018-02-05 19:04
ok, it's fine for me, I close this issue
History
Date User Action Args
2022-04-11 14:58:57adminsetgithub: 76955
2018-02-05 19:04:46matrixisesetstatus: open -> closed

messages: + msg311681
stage: patch review -> resolved
2018-02-05 18:12:51r.david.murraysetnosy: + r.david.murray
messages: + msg311680
2018-02-05 16:39:31matrixisesetmessages: + msg311674
2018-02-05 16:38:23matrixisesetkeywords: + patch
stage: patch review
pull_requests: + pull_request5377
2018-02-05 16:35:56matrixisecreate