gh-84232: Fix pydoc docs.python.org link generation
#139995
Conversation
|
Requesting Serhiy per experts list. |
|
UBSan failure is unrelated. |
|
@picnixz Thanks for the helpful reviews on the (other) |
Lib/pydoc.py
Outdated
| module_docs = None | ||
|
|
||
| if object.__name__ in module_docs.module_docs: |
There was a problem hiding this comment.
module_docs.module_docs is invalid if module_docs is None.
There was a problem hiding this comment.
Note that the above code contains a lot of hardcoded special cases. We could add few more special cases for modules documented in other file.
If generate the mapping in Sphynx, then these special cases may be not needed. But such solution perhaps cannot be backported.
This code only works for installed Python, so it will not be easy to tests it.
There was a problem hiding this comment.
This code only works for installed Python, so it will not be easy to tests it.
It does not have to, with #139997 refactoring/improving the stdlib module check this will be accounted for.
There was a problem hiding this comment.
If generate the mapping in Sphynx, then these special cases may be not needed. But such solution perhaps cannot be backported.
Why not, we can regenerate the data in the backport?
There was a problem hiding this comment.
The original comment here has been addressed.
StanFromIreland
changed the title
pydoc docs.python.org link generationpydoc docs.python.org link generation
2 participants
pydocinncorrectly assumes a module has documentation and where #139971📚 Documentation preview 📚: https://cpython-previews--139995.org.readthedocs.build/