Add missing docstrings for documented public APIs #3388
Closed
+40
−2
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.
Summary
Addresses #3221 by adding docstrings to all items identified as appearing in the Sphinx documentation without a docstring.
Changes:
MemorySendChannelandMemoryReceiveChannel: Added class-level docstrings describing these as the sending/receiving ends of a memory channel, with cross-references toopen_memory_channeland the channel-mpmc section.MemoryChannelStatistics: Added a class docstring explaining it is the return type of.statistics()and pointing toopen_memory_channelfor field details.SocketStream.send_all,.receive_some,.send_eof,.wait_send_all_might_not_block,.aclose: Added brief docstrings that reference the parent ABC method (e.g. "Seetrio.abc.SendStream.send_all."). Also removed:undoc-members:from theSocketStreamautoclass RST directive since all methods now have docstrings.HasFileno.fileno: Added a one-line docstring.ParkingLot.broken_by: Added an attribute docstring explaining what the list contains and its effect onpark.Includes a
3221.doc.rstnewsfragment.Test plan
🤖 Generated with Claude Code