[issue47255] Many broken :meth: roles in the docs
New submission from Jelle Zijlstra <jelle.zijlstra@gmail.com>: The docs for the hash() builtin use :meth:`__hash__`, but this doesn't actually link to the datamodel documentation for __hash__: it needs :meth:`~object.__hash__` instead. I'm fixing this in the builtin functions docs, but there are probably more places. Why don't we warn when a :meth: link doesn't actually create a link? ---------- assignee: docs@python components: Documentation messages: 416956 nosy: JelleZijlstra, docs@python priority: normal severity: normal status: open title: Many broken :meth: roles in the docs versions: Python 3.10, Python 3.11, Python 3.9 _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue47255> _______________________________________
Change by Jelle Zijlstra <jelle.zijlstra@gmail.com>: ---------- keywords: +patch pull_requests: +30435 stage: -> patch review pull_request: https://github.com/python/cpython/pull/32409 _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue47255> _______________________________________
Jelle Zijlstra <jelle.zijlstra@gmail.com> added the comment: There are a lot of places in the rest of the docs that have the same problem: Doc % git grep ':meth:`__' | grep -v whatsnew | wc -l 610 I wonder if we can make the :meth: role globally default to linking to object.__dunder__. Would that require a change to Sphinx? ---------- _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue47255> _______________________________________
Ken Jin <kenjin4096@gmail.com> added the comment: It's 3.10 only. Presumably our sphinx version changed then and something broke. In 3.9 and earlier the links are all fine. See https://bugs.python.org/issue42182 for a similar issue I raised ages ago. ---------- nosy: +kj _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue47255> _______________________________________
participants (2)
-
Jelle Zijlstra
-
Ken Jin