Skip to content

docs: Small clarity change for except* #121073

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 4 commits into from
Aug 6, 2025
Merged

docs: Small clarity change for except* #121073

merged 4 commits into from
Aug 6, 2025

Conversation

gstein
Copy link
Contributor

@gstein gstein commented Jun 27, 2024

In the except* discussion, four keywords are linked in a row: try, break, continue, and return. Visually, it is easy to miss the period after the try. Adding a couple words (and the capitalization) after the period helps the reader notice the separate concerns of the keywords.


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

In the except* discussion, four keywords are linked in a row: try, break, continue, and return. Visually, it is easy to miss the period after the "try". Adding a couple words (and the capitalization) after the period helps the reader notice the separate concerns of the keywords.
@bedevere-app bedevere-app bot added docs Documentation in the Doc dir skip news awaiting review labels Jun 27, 2024
@gstein gstein changed the title gh-N/A: Small clarity change for except* docs: Small clarity change for except* Jun 27, 2024
Copy link
Member

@StanFromIreland StanFromIreland left a comment

Choose a reason for hiding this comment

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

I don’t see a particular benefit, it reads fine to me either way. cc @iritkatriel

@gstein
Copy link
Contributor Author

gstein commented Jul 30, 2025

I don’t see a particular benefit, it reads fine to me either way. cc @iritkatriel

I'm empirical evidence that the period is easy to miss, so putting two words in there helps with reading and clarity.

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.

Looks fine, but shall we combine the lines:

@AA-Turner AA-Turner added needs backport to 3.13 bugs and security fixes needs backport to 3.14 bugs and security fixes labels Jul 31, 2025
I originally inserted two words for minimal change. The suggestion reads much better.

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
@gstein gstein requested a review from willingc as a code owner July 31, 2025 20:01
gstein and others added 2 commits July 31, 2025 15:01
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
@AA-Turner AA-Turner enabled auto-merge (squash) August 6, 2025 21:52
@AA-Turner AA-Turner merged commit c653fba into python:main Aug 6, 2025
24 of 25 checks passed
@github-project-automation github-project-automation bot moved this from Todo to Done in Docs PRs Aug 6, 2025
@miss-islington-app
Copy link

Thanks @gstein for the PR, and @AA-Turner for merging it 🌮🎉.. I'm working now to backport this PR to: 3.13, 3.14.
🐍🍒⛏🤖

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Aug 6, 2025
(cherry picked from commit c653fba)

Co-authored-by: Greg Stein <gstein@gmail.com>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Aug 6, 2025
(cherry picked from commit c653fba)

Co-authored-by: Greg Stein <gstein@gmail.com>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
@bedevere-app
Copy link

bedevere-app bot commented Aug 6, 2025

GH-137494 is a backport of this pull request to the 3.14 branch.

@bedevere-app bedevere-app bot removed the needs backport to 3.14 bugs and security fixes label Aug 6, 2025
@bedevere-app
Copy link

bedevere-app bot commented Aug 6, 2025

GH-137495 is a backport of this pull request to the 3.13 branch.

@bedevere-app bedevere-app bot removed the needs backport to 3.13 bugs and security fixes label Aug 6, 2025
AA-Turner added a commit that referenced this pull request Aug 6, 2025
Co-authored-by: Greg Stein <gstein@gmail.com>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
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
Status: Done
Development

Successfully merging this pull request may close these issues.

5 participants