Clarify documentation around close, flush, and isopen
#58020
Merged
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
The previous documentation was unclear about what "closing" something actually meant, what you could expect from a closed resource, and whether it was usable in generic code. It also mixed up closing IO object, timers and events, where the semantics are different. In this commit: * The docstring of `close` and `flush` has been expanded. * `close` has been given a generic implementation * The documentation details specific to `IOStream`, `Timer` and `Asyncevent` has been moved to specific docstrings, such that the *generic* behaviour of these functions aren't mixed up with the specifics of e.g. `IOStream`.
jakobnissen
added
io
fingolfin
reviewed
May 8, 2025
fingolfin
reviewed
May 8, 2025
fingolfin
reviewed
May 8, 2025
fingolfin
reviewed
May 8, 2025
fingolfin
reviewed
May 8, 2025
fingolfin
reviewed
May 8, 2025
Co-authored-by: Max Horn <max@quendi.de>
jakobnissen
added
status: waiting for PR reviewer
and removed
status: waiting for author
labels
fingolfin
approved these changes
Jun 1, 2025
fingolfin
added
merge me
IanButterworth
removed
the
merge me
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 previous documentation was unclear about what "closing" something actually meant, what you could expect from a closed resource, and whether it was usable in generic code.
It also mixed up closing IO object, timers and events, where the semantics are different.
In this commit:
closeandflushhas been expanded.closehas been given a generic implementationIOStream,TimerandAsynceventhas been moved to specific docstrings, such that the generic behaviour of these functions aren't mixed up with the specifics of e.g.IOStream.Closes #57944