Skip to content

gh-141984: Add "exhausted" to glossary, link existing mentions - #157225

Open
encukou wants to merge 1 commit into
python:mainfrom
encukou:add-exhausted
Open

gh-141984: Add "exhausted" to glossary, link existing mentions#157225
encukou wants to merge 1 commit into
python:mainfrom
encukou:add-exhausted

Conversation

@encukou

@encukou encukou commented Sep 9, 2026

Copy link
Copy Markdown
Member

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.)

Co-authored-by: Blaise Pabon <blaise@gmail.com>
@read-the-docs-community

Copy link
Copy Markdown

Comment thread Doc/glossary.rst
Comment on lines +512 to +513
:py:func:`next`) raise :py:exc:`StopIteration`
(or :py:exc:`StopAsyncIteration` in the case of an :term:`asynchronous

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.

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?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

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.

@StanFromIreland StanFromIreland Sep 9, 2026

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.

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

awaiting merge docs Documentation in the Doc dir skip news

Projects

Status: Todo

Development

Successfully merging this pull request may close these issues.

2 participants