gh-84232: Fix doc links in module help() output #29419
Closed
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
merwok
reviewed
Nov 8, 2021
merwok
reviewed
Nov 8, 2021
merwok
reviewed
Nov 8, 2021
merwok
reviewed
Nov 8, 2021
|
This PR is stale because it has been open for 30 days with no activity. |
zware
force-pushed
the
pydoc_link_fix
branch
from
46ef6e6 to
d86b55c
Compare
zware
changed the title
zware
force-pushed
the
pydoc_link_fix
branch
from
d86b55c to
4a4ecc9
Compare
An explicit mapping of module names to documentation names is added to pydoc_data.topics and is used by pydoc's `getdocloc` function to generate more-correct URLs in more cases without special-casing particular modules. In some cases this corrects the displayed link to give a real page and in other cases removes what was previously an incorrect link entirely.
zware
force-pushed
the
pydoc_link_fix
branch
from
4a4ecc9 to
d4b3820
Compare
merwok
reviewed
Sep 29, 2024
Member
|
I missed this PR and opened #139995, which is a similar approach. What do you want to do Zachary? I can close mine. |
Member
|
Completed in f9704f1 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
6 participants
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.
An explicit mapping of module names to documentation names is added to
pydoc_data.topics and is used by pydoc's
getdoclocfunction togenerate more-correct URLs in more cases without special-casing
particular modules. In some cases (tkinter.simpledialog, lib2to3, etc.)
this corrects the displayed link to give a real page and in other cases
(private or undocumented modules) removes what was previously an
incorrect link entirely.
https://bugs.python.org/issue40051