Issue32774
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) *  |
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) * |
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) * |
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:57 | admin | set | github: 76955 |
| 2018-02-05 19:04:46 | matrixise | set | status: open -> closed messages:
+ msg311681 |
| 2018-02-05 18:12:51 | r.david.murray | set | nosy:
+ r.david.murray messages: + msg311680 |
| 2018-02-05 16:39:31 | matrixise | set | messages: + msg311674 |
| 2018-02-05 16:38:23 | matrixise | set | keywords:
+ patch stage: patch review pull_requests: + pull_request5377 |
| 2018-02-05 16:35:56 | matrixise | create | |