[issue18589] cross-referencing doesn't work between the extending guide and c-api
New submission from Antoine Pitrou: It doesn't seem possible to make reference links to e.g. the definition for tp_clear. Both :attr:`tp_clear` and :attr:`PyTypeObject.tp_clear` do not make any link. The extending guide is littered with such broken references. ---------- assignee: docs@python components: Documentation messages: 193887 nosy: docs@python, eric.araujo, ezio.melotti, georg.brandl, pitrou priority: high severity: normal status: open title: cross-referencing doesn't work between the extending guide and c-api type: behavior versions: Python 2.7, Python 3.3, Python 3.4 _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue18589> _______________________________________
Antoine Pitrou added the comment: Ahah, it seems the correct markup is :c:member:`~PyTypeObject.tp_clear` Now all the existing references have to be fixed... ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue18589> _______________________________________
Antoine Pitrou added the comment: The following command does the trick: sed -i "s/:attr:\`tp_/:c:member:\`~PyTypeObject.tp_/g" `find -name "*.rst"` It does not fix word-wrapping, though. Is it ok to commit? ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue18589> _______________________________________
Roundup Robot added the comment: New changeset a381721299a3 by Antoine Pitrou in branch '3.3': Issue #18589: fix hyperlinking of type slots (tp_*) http://hg.python.org/cpython/rev/a381721299a3 New changeset 36ff479e429c by Antoine Pitrou in branch 'default': Issue #18589: fix hyperlinking of type slots (tp_*) http://hg.python.org/cpython/rev/36ff479e429c ---------- nosy: +python-dev _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue18589> _______________________________________
Roundup Robot added the comment: New changeset bb546f6d8ab4 by Antoine Pitrou in branch '2.7': Issue #18589: fix hyperlinking of type slots (tp_*) http://hg.python.org/cpython/rev/bb546f6d8ab4 ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue18589> _______________________________________
Changes by Antoine Pitrou <pitrou@free.fr>: ---------- resolution: -> fixed stage: -> committed/rejected status: open -> closed _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue18589> _______________________________________
participants (2)
-
Antoine Pitrou -
Roundup Robot