ast docs: Fix incorrect link on keyword
#108728
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
'Grammar-level *keyword*' != 'Function signature *keyword* argument' From https://devguide.python.org/documentation/markup/#roles : > Normally, names in these roles are searched first without any further > qualification, then with the current module name prepended, then with > the current module and class name (if any) prepended. If you prefix > the name with a dot, this order is reversed. So the global `keyword` module was found first; fix by forcing local search.
|
All commit authors signed the Contributor License Agreement. |
AlexWaygood
changed the title
ast.keyword linked to Lib/keyword moduleast docs: Fix incorrect link on keyword
AlexWaygood
added
needs backport to 3.11
|
Thanks @alexpovel for the PR, and @AlexWaygood for merging it 🌮🎉.. I'm working now to backport this PR to: 3.11, 3.12. |
|
GH-108737 is a backport of this pull request to the 3.12 branch. |
|
GH-108738 is a backport of this pull request to the 3.11 branch. |
miss-islington
pushed a commit
to miss-islington/cpython
that referenced
this pull request
Aug 31, 2023
In two places, Sphinx was erroneously adding links to the `keyword` module instead of the `ast.keyword` class (cherry picked from commit c1e2f3b) Co-authored-by: Alex Povel <[email protected]>
miss-islington
pushed a commit
to miss-islington/cpython
that referenced
this pull request
Aug 31, 2023
In two places, Sphinx was erroneously adding links to the `keyword` module instead of the `ast.keyword` class (cherry picked from commit c1e2f3b) Co-authored-by: Alex Povel <[email protected]>
AlexWaygood
pushed a commit
that referenced
this pull request
Aug 31, 2023
`ast` docs: Fix incorrect link on `keyword` (GH-108728) In two places, Sphinx was erroneously adding links to the `keyword` module instead of the `ast.keyword` class (cherry picked from commit c1e2f3b) Co-authored-by: Alex Povel <[email protected]>
Yhg1s
pushed a commit
that referenced
this pull request
Sep 1, 2023
`ast` docs: Fix incorrect link on `keyword` (GH-108728) In two places, Sphinx was erroneously adding links to the `keyword` module instead of the `ast.keyword` class (cherry picked from commit c1e2f3b) Co-authored-by: Alex Povel <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
'Grammar-level keyword' != 'Function signature keyword argument'
From https://devguide.python.org/documentation/markup/#roles :
So the global
keywordmodule was found first; fix by forcing local search.Check current docs, where
keywordcontains the wrong link.📚 Documentation preview 📚: https://cpython-previews--108728.org.readthedocs.build/