Skip to content

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

Merged
merged 8 commits into from
Aug 6, 2023

Conversation

kamilturek
Copy link
Contributor

@kamilturek kamilturek commented Aug 5, 2023

  • Added missing ticks around sys.path in a few places.
  • Lowercased text in parentheses.

📚 Documentation preview 📚: https://cpython-previews--107673.org.readthedocs.build/

@bedevere-bot bedevere-bot added docs Documentation in the Doc dir skip news labels Aug 5, 2023
@kamilturek kamilturek marked this pull request as ready for review August 5, 2023 21:54
Copy link
Member

@AA-Turner AA-Turner left a 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

@AA-Turner AA-Turner added needs backport to 3.11 only security fixes needs backport to 3.12 only security fixes labels Aug 6, 2023
@AA-Turner AA-Turner changed the title Docs: add missing ticks to Doc/library/runpy.rst Use literal syntax for sys.path in Doc/library/runpy.rst Aug 6, 2023
@kamilturek
Copy link
Contributor Author

@AA-Turner Thanks for the review. I addressed your comments.

Copy link
Member

@AA-Turner AA-Turner left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

A

Copy link
Member

@AlexWaygood AlexWaygood left a 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!

@kamilturek
Copy link
Contributor Author

@AlexWaygood I saw that the other already existing sys.path occurrences were not linked so I just followed the approach. But I agree that it's a good idea. I'll make an update. Thanks!

@AA-Turner
Copy link
Member

Even better than adding backticks would be to link to the docs for sys.path!

Ahh, should've thought of that! Thanks for spotting this :)

A

@AA-Turner AA-Turner changed the title Use literal syntax for sys.path in Doc/library/runpy.rst Add cross-references to sys.path in Doc/library/runpy.rst Aug 6, 2023
Copy link
Member

@AlexWaygood AlexWaygood left a 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!

@AlexWaygood AlexWaygood changed the title Add cross-references to sys.path in Doc/library/runpy.rst Improve cross-references in runpy docs Aug 6, 2023
@kamilturek
Copy link
Contributor Author

@AlexWaygood Thanks for all the help!

@AlexWaygood AlexWaygood enabled auto-merge (squash) August 6, 2023 21:03
@AlexWaygood AlexWaygood merged commit 4e242d1 into python:main Aug 6, 2023
@miss-islington
Copy link
Contributor

Thanks @kamilturek for the PR, and @AlexWaygood for merging it 🌮🎉.. I'm working now to backport this PR to: 3.11, 3.12.
🐍🍒⛏🤖

@bedevere-bot
Copy link

GH-107698 is a backport of this pull request to the 3.12 branch.

@bedevere-bot bedevere-bot removed the needs backport to 3.12 only security fixes label Aug 6, 2023
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Aug 6, 2023
- 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]>
@bedevere-bot
Copy link

GH-107699 is a backport of this pull request to the 3.11 branch.

@bedevere-bot bedevere-bot removed the needs backport to 3.11 only security fixes label Aug 6, 2023
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Aug 6, 2023
- 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]>
@kamilturek kamilturek deleted the doc-runpy-fixes branch August 6, 2023 21:11
AlexWaygood pushed a commit that referenced this pull request Aug 6, 2023
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]>
Yhg1s pushed a commit that referenced this pull request Aug 6, 2023
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]>
kostyafarber pushed a commit to kostyafarber/cpython that referenced this pull request Aug 7, 2023
- 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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation in the Doc dir skip issue skip news
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants