docs: Small clarity change for except* #121073
Open
+1
−1
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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.
eendebakpt
approved these changes
Jun 28, 2024
There was a problem hiding this comment.
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. |
AA-Turner
approved these changes
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>
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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
In the
except*discussion, four keywords are linked in a row:try,break,continue, andreturn. Visually, it is easy to miss the period after thetry. 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/