Skip to content

gh-84232: Fix doc links in module help() output - #29419

Closed
zware wants to merge 2 commits into
python:mainfrom
zware:pydoc_link_fix
Closed

gh-84232: Fix doc links in module help() output#29419
zware wants to merge 2 commits into
python:mainfrom
zware:pydoc_link_fix

Conversation

@zware

@zwarezware commented Nov 5, 2021•
edited by bedevere-app Bot
Loading

Copy link
Copy Markdown
Member

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 (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

merwok
merwok reviewed Nov 8, 2021
View reviewed changes
Comment threadDoc/tools/extensions/pyspecific.py Outdated
merwok
merwok reviewed Nov 8, 2021
View reviewed changes
Comment threadLib/pydoc.py Outdated
merwok
merwok reviewed Nov 8, 2021
View reviewed changes
Comment threadLib/pydoc.py Outdated
merwok
merwok reviewed Nov 8, 2021
View reviewed changes
Comment threadLib/pydoc_data/topics.py Outdated
@github-actions

github-actionsBot commented Dec 9, 2021

Copy link
Copy Markdown

This PR is stale because it has been open for 30 days with no activity.

@github-actionsgithub-actionsBot added the stale Stale PR or inactive for long period of time. label Dec 9, 2021
@zwarezware mentioned this pull request Apr 20, 2022
Closed
@zwarezware changed the title bpo-40051: Fix doc links in module help() outputgh-84232: Fix doc links in module help() outputSep 27, 2024
@zware
pythongh-84232: Fix doc links in module help() output
d4b3820
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.
@zwarezware removed the stale Stale PR or inactive for long period of time. label Sep 27, 2024
merwok
merwok reviewed Sep 29, 2024
View reviewed changes
Comment threadLib/test/test_pydoc/test_pydoc.py Outdated
@zwarezware mentioned this pull request Oct 13, 2025
Closed
@StanFromIreland

StanFromIreland commented Oct 13, 2025

Copy link
Copy Markdown
Member

I missed this PR and opened #139995, which is a similar approach. What do you want to do Zachary? I can close mine.

@StanFromIreland

StanFromIreland commented Dec 23, 2025

Copy link
Copy Markdown
Member

Completed in f9704f1

@zware
zware deleted the pydoc_link_fix branch December 23, 2025 15:07
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@merwokmerwokmerwok left review comments
@terryjreedyterryjreedyAwaiting requested review from terryjreedy

Assignees

No one assigned

Labels

awaiting core review

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

7 participants

@zware@StanFromIreland@merwok@the-knights-who-say-ni@ezio-melotti@bedevere-bot@nazeerali4325-commits