-
-
Notifications
You must be signed in to change notification settings - Fork 32.1k
Improve cross-references in runpy
docs
#107673
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.
Thanks for this PR! Some comments:
A
sys.path
in Doc/library/runpy.rst
@AA-Turner Thanks for the review. I addressed your comments. |
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.
Thanks!
A
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.
Even better than adding backticks would be to link to the docs for sys.path
!
@AlexWaygood I saw that the other already existing |
Ahh, should've thought of that! Thanks for spotting this :) A |
sys.path
in Doc/library/runpy.rst
sys.path
in Doc/library/runpy.rst
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.
Looks great, thank you!
sys.path
in Doc/library/runpy.rst
runpy
docs
@AlexWaygood Thanks for all the help! |
Thanks @kamilturek for the PR, and @AlexWaygood for merging it 🌮🎉.. I'm working now to backport this PR to: 3.11, 3.12. |
GH-107698 is a backport of this pull request to the 3.12 branch. |
- Add links to `__main__` and `sys.path` where appropriate - Ensure each paragraph never has more than one link to the same thing, to avoid visual clutter from too many links (cherry picked from commit 4e242d1) Co-authored-by: Kamil Turek <[email protected]>
GH-107699 is a backport of this pull request to the 3.11 branch. |
- Add links to `__main__` and `sys.path` where appropriate - Ensure each paragraph never has more than one link to the same thing, to avoid visual clutter from too many links (cherry picked from commit 4e242d1) Co-authored-by: Kamil Turek <[email protected]>
Improve cross-references in `runpy` docs (GH-107673) - Add links to `__main__` and `sys.path` where appropriate - Ensure each paragraph never has more than one link to the same thing, to avoid visual clutter from too many links (cherry picked from commit 4e242d1) Co-authored-by: Kamil Turek <[email protected]>
Improve cross-references in `runpy` docs (GH-107673) - Add links to `__main__` and `sys.path` where appropriate - Ensure each paragraph never has more than one link to the same thing, to avoid visual clutter from too many links (cherry picked from commit 4e242d1) Co-authored-by: Kamil Turek <[email protected]>
- Add links to `__main__` and `sys.path` where appropriate - Ensure each paragraph never has more than one link to the same thing, to avoid visual clutter from too many links
sys.path
in a few places.Lowercased text in parentheses.📚 Documentation preview 📚: https://cpython-previews--107673.org.readthedocs.build/