Add docstrings to StreamReader and DataQueue public methods#12309
Closed
mastash3ff wants to merge 3 commits intoaio-libs:masterfrom
Closed
Add docstrings to StreamReader and DataQueue public methods#12309mastash3ff wants to merge 3 commits intoaio-libs:masterfrom
mastash3ff wants to merge 3 commits intoaio-libs:masterfrom
Conversation
The StreamReader and DataQueue classes in aiohttp/streams.py are core public APIs used extensively by aiohttp consumers, but most of their public methods lacked docstrings. This adds concise docstrings describing the behavior, return values, and exceptions for all undocumented public methods on both classes, as well as class-level docstrings for the supporting iterator types.
psf-chronographer
bot
added
the
bot:chronographer:provided
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #12309 +/- ##
==========================================
- Coverage 99.11% 99.11% -0.01%
==========================================
Files 130 130
Lines 45558 45558
Branches 2404 2404
==========================================
- Hits 45156 45155 -1
Misses 272 272
- Partials 130 131 +1
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
Author
|
Closing — this PR was opened by an automated contribution agent that has been disabled. Apologies for the noise. |
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
1 participant
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.
What do these changes do?
Adds docstrings to all undocumented public methods on
StreamReader,DataQueue, and the supporting iterator classes (AsyncStreamIterator,ChunkTupleAsyncStreamIterator,AsyncStreamReaderMixin) inaiohttp/streams.py.These are core public APIs consumed by virtually all aiohttp users, but most methods had no docstrings. Each new docstring concisely describes the method's behavior, return values, and exceptions raised.
Are there changes in behavior for the user?
No. This is a documentation-only change — no logic, tests, or runtime behavior is modified.
Is it a substantial burden for the maintainers to support this?
No. Pure docstring additions with no functional impact.
Related issue number
N/A — general documentation improvement.
Checklist
CONTRIBUTORS.txtCHANGES/folder0.doc.rst— will rename to match PR number after creation