Skip to content

Improve cross-references in runpy docs - #107673

Merged
AlexWaygood merged 8 commits into
python:mainfrom
kamilturek:doc-runpy-fixes
Aug 6, 2023
Merged

Improve cross-references in runpy docs#107673
AlexWaygood merged 8 commits into
python:mainfrom
kamilturek:doc-runpy-fixes

Conversation

@kamilturek

@kamilturekkamilturek commented Aug 5, 2023•
edited
Loading

Copy link
Copy Markdown
Contributor
  • Added missing ticks around sys.path in a few places.
  • Lowercased text in parentheses.

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

@bedevere-botbedevere-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
AA-Turner
AA-Turner requested changes Aug 6, 2023
View reviewed changes

@AA-TurnerAA-Turner left a comment

Copy link
Copy Markdown
Member

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

Comment threadDoc/library/runpy.rst Outdated
Comment threadDoc/library/runpy.rst Outdated
Comment threadDoc/library/runpy.rst Outdated
@AA-TurnerAA-Turner added needs backport to 3.11 only security fixes needs backport to 3.12 only security fixes labels Aug 6, 2023
@AA-TurnerAA-Turner changed the title Docs: add missing ticks to Doc/library/runpy.rstUse literal syntax for sys.path in Doc/library/runpy.rstAug 6, 2023
@kamilturek

kamilturek commented Aug 6, 2023

Copy link
Copy Markdown
ContributorAuthor

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

AA-Turner
AA-Turner approved these changes Aug 6, 2023
View reviewed changes

@AA-TurnerAA-Turner left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thanks!

A

AlexWaygood
AlexWaygood reviewed Aug 6, 2023
View reviewed changes

@AlexWaygoodAlexWaygood left a comment

Copy link
Copy Markdown
Member

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!

Comment threadDoc/library/runpy.rst Outdated
Comment threadDoc/library/runpy.rst Outdated
Comment threadDoc/library/runpy.rst Outdated
Comment threadDoc/library/runpy.rst Outdated
Comment threadDoc/library/runpy.rst Outdated
@kamilturek

kamilturek commented Aug 6, 2023

Copy link
Copy Markdown
ContributorAuthor

@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

AA-Turner commented Aug 6, 2023

Copy link
Copy Markdown
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-TurnerAA-Turner changed the title Use literal syntax for sys.path in Doc/library/runpy.rstAdd cross-references to sys.path in Doc/library/runpy.rstAug 6, 2023
kamilturek
kamilturek commented Aug 6, 2023
View reviewed changes
Comment threadDoc/library/runpy.rst Outdated
AlexWaygood
AlexWaygood reviewed Aug 6, 2023
View reviewed changes
Comment threadDoc/library/runpy.rst Outdated
Comment threadDoc/library/runpy.rst Outdated
Comment threadDoc/library/runpy.rst Outdated
Comment threadDoc/library/runpy.rst Outdated
AlexWaygood
AlexWaygood approved these changes Aug 6, 2023
View reviewed changes

@AlexWaygoodAlexWaygood left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Looks great, thank you!

@AlexWaygoodAlexWaygood changed the title Add cross-references to sys.path in Doc/library/runpy.rstImprove cross-references in runpy docsAug 6, 2023
@kamilturek

kamilturek commented Aug 6, 2023

Copy link
Copy Markdown
ContributorAuthor

@AlexWaygood Thanks for all the help!

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

miss-islington commented Aug 6, 2023

Copy link
Copy Markdown
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

bedevere-bot commented Aug 6, 2023

Copy link
Copy Markdown

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

@bedevere-botbedevere-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
@kamilturek@miss-islington
Improve cross-references inrunpydocs (pythonGH-107673)
7ede48c
- 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 <kamil.turek@hotmail.com>
@bedevere-bot

bedevere-bot commented Aug 6, 2023

Copy link
Copy Markdown

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

@bedevere-botbedevere-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
@kamilturek@miss-islington
Improve cross-references inrunpydocs (pythonGH-107673)
f9e9ce9
- 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 <kamil.turek@hotmail.com>
@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
@miss-islington@kamilturek
[3.11] Improve cross-references inrunpydocs (GH-107673) (#107699)
1878419
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 <kamil.turek@hotmail.com>
Yhg1s pushed a commit that referenced this pull request Aug 6, 2023
@miss-islington@kamilturek
[3.12] Improve cross-references inrunpydocs (GH-107673) (#107698)
ab1988d
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 <kamil.turek@hotmail.com>
kostyafarber pushed a commit to kostyafarber/cpython that referenced this pull request Aug 7, 2023
@kamilturek@kostyafarber
Improve cross-references inrunpydocs (python#107673)
bc3d1eb
- 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 freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@AA-TurnerAA-TurnerAA-Turner approved these changes
@AlexWaygoodAlexWaygoodAlexWaygood approved these changes

Assignees

No one assigned

Labels

docsDocumentation in the Doc dirskip issueskip news

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

6 participants

@kamilturek@AA-Turner@miss-islington@bedevere-bot@AlexWaygood@hauntsaninja