gh-141984: Add "exhausted" to glossary, link existing mentions - #157225
Open
encukou wants to merge 1 commit into
Open
gh-141984: Add "exhausted" to glossary, link existing mentions#157225encukou wants to merge 1 commit into
encukou wants to merge 1 commit into
Conversation
Co-authored-by: Blaise Pabon <blaise@gmail.com>
encukou
requested review from
AA-Turner,
ZeroIntensity,
rhettinger and
willingc
as code owners
September 9, 2026 15:48
Documentation build overview
|
Comment on lines
+512
to
+513
| :py:func:`next`) raise :py:exc:`StopIteration` | ||
| (or :py:exc:`StopAsyncIteration` in the case of an :term:`asynchronous |
Member
There was a problem hiding this comment.
Suggested change
| :py:func:`next`) raise :py:exc:`StopIteration` | |
| (or :py:exc:`StopAsyncIteration` in the case of an :term:`asynchronous | |
| :func:`next`) raise :exc:`StopIteration` | |
| (or :exc:`StopAsyncIteration` in the case of an :term:`asynchronous |
Why are we specifying the :py: domain here, it's the default?
Member
Author
There was a problem hiding this comment.
I work on pure-Python & C API docs, so I tend to write the domain explicitly rather than look at the current file's default. I hope that's not a problem.
Member
There was a problem hiding this comment.
I'd personally prefer not to add domains when we don't have to (i.e., outside of the C-API docs). I find the extra qualification just adds noise to the docs, and admittedly, I also prefer to be consistent.
But, I won't block on this.
StanFromIreland
approved these changes
Sep 9, 2026
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
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.
The term “exhausted” is used quite a lot for iterators. Add a glossary entry for it, and link to that from all relevant uses. (Things like memory exhaustion or non-exhaustive lists aren't linked.)
(Tagged with #141984 since this grew out of improving syntax docs. It's only tangentially related, but IMO better than not linking to an issue.)