GH-121970: Extract issue_role into a new extension
#130615
Conversation
AA-Turner
added
docs
AA-Turner
changed the title
issue_role into a new extension
| return [prb], [msg] | ||
|
|
||
| issue_url = self.ISSUE_URI.format(issue) | ||
| refnode = nodes.reference(issue, f"bpo-{issue}", refuri=issue_url) |
There was a problem hiding this comment.
Here we're passing something like 12345 and bpo-12345 as the first two arguments.
Before we were passing something like bpo-12345 and bpo-12345 for both.
I see the second one is used in the refnode:
<reference refuri="https://bugs.python.org/issue?@action=redirect&bpo=13936">bpo-13936</reference>
How is the first one used?
There was a problem hiding this comment.
It's the docutils rawsource, it should reflect what was actually written in the document.
Sphinx uses this for translation, I don't think these nodes are translatable but I'll double check.
A
There was a problem hiding this comment.
See e.g. https://github.com/python/python-docs-fr/blob/3.13/whatsnew/3.13.po#L394-L399, the whole role is included in the translation string.
There was a problem hiding this comment.
So should it match 12345 or bpo-12345?
There was a problem hiding this comment.
(Unresolving so the question isn't hidden :)
There was a problem hiding this comment.
The text of what is actually written in the document, so "14159".
Co-authored-by: Hugo van Kemenade <[email protected]>
|
Thanks @AA-Turner for the PR 🌮🎉.. I'm working now to backport this PR to: 3.12, 3.13. |
…H-130615) (cherry picked from commit 043ab3a) Co-authored-by: Adam Turner <[email protected]> Co-authored-by: Hugo van Kemenade <[email protected]>
|
GH-130651 is a backport of this pull request to the 3.13 branch. |
…H-130615) (cherry picked from commit 043ab3a) Co-authored-by: Adam Turner <[email protected]> Co-authored-by: Hugo van Kemenade <[email protected]>
|
GH-130652 is a backport of this pull request to the 3.12 branch. |
) (#130651) (cherry picked from commit 043ab3a) Co-authored-by: Adam Turner <[email protected]> Co-authored-by: Hugo van Kemenade <[email protected]>
) (#130652) (cherry picked from commit 043ab3a) Co-authored-by: Adam Turner <[email protected]> Co-authored-by: Hugo van Kemenade <[email protected]>
…130615) Co-authored-by: Hugo van Kemenade <[email protected]>
2 participants
pyspecific#121970📚 Documentation preview 📚: https://cpython-previews--130615.org.readthedocs.build/