[docs] [issue32774] distutils: cyclic reference in the documentation

R. David Murray report at bugs.python.org
Mon Feb 5 13:12:51 EST 2018

R. David Murray <rdmurray at bitdance.com> added the comment:

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.

nosy: +r.david.murray

Python tracker <report at bugs.python.org>

More information about the docs mailing list