-
-
Notifications
You must be signed in to change notification settings - Fork 32.2k
GH-56426: Add cross-reference to the documentation for faulthandler, traceback, and pdb. #101157
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In general, and as seems to be typically done in practice, from what I've seen, module-level see-alsos are usually work best near the beginning of the doc, at the end of the module-level summary/description and before the first section, function, classes, methods, etc, rather than buried at the end. This keeps them in the same place as the other module-level information, rather than part of an unrelated section, and makes it much easy for readers to find other related modules that might suit their use case better without having to read through the entire module doc first.
Also, a couple suggestions.
Co-authored-by: C.A.M. Gerlach <[email protected]>
Co-authored-by: C.A.M. Gerlach <[email protected]>
Co-authored-by: C.A.M. Gerlach <[email protected]>
More specifically, I suggest moving the See-Also block in...
Thanks! |
I went over the pickle and reg module documentation, adding a see also section. Sections were added below the documents. I completely agree that see-also section at the beginning of the document would be more useful and attention-grabbing. Thank you very much for your assistance and line-by-line explanation ! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, thanks @furkanonder !
Thanks @furkanonder for the PR, and @kumaraditya303 for merging it 🌮🎉.. I'm working now to backport this PR to: 3.10, 3.11. |
GH-101554 is a backport of this pull request to the 3.11 branch. |
…dler, traceback, and pdb. (pythonGH-101157) (cherry picked from commit cef9de6) Co-authored-by: Furkan Onder <[email protected]> Co-authored-by: C.A.M. Gerlach <[email protected]>
GH-101555 is a backport of this pull request to the 3.10 branch. |
…dler, traceback, and pdb. (pythonGH-101157) (cherry picked from commit cef9de6) Co-authored-by: Furkan Onder <[email protected]> Co-authored-by: C.A.M. Gerlach <[email protected]>
…traceback, and pdb. (GH-101157) (cherry picked from commit cef9de6) Co-authored-by: Furkan Onder <[email protected]> Co-authored-by: C.A.M. Gerlach <[email protected]>
…traceback, and pdb. (GH-101157) (cherry picked from commit cef9de6) Co-authored-by: Furkan Onder <[email protected]> Co-authored-by: C.A.M. Gerlach <[email protected]>
Uh oh!
There was an error while loading. Please reload this page.