docs: add missing docstrings for public API#3404
docs: add missing docstrings for public API#3404nightcityblade wants to merge 3 commits intopython-trio:mainfrom
Conversation
Add docstrings to: - MemorySendChannel class - MemoryReceiveChannel class - MemoryChannelStatistics class and attributes - SocketStream.send_all, wait_send_all_might_not_block, send_eof, receive_some, aclose - HasFileno.fileno - ParkingLot.broken_by attribute Fixes python-trio#3221
|
See discussion in #3388 |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #3404 +/- ##
===============================================
Coverage 100.00000% 100.00000%
===============================================
Files 128 128
Lines 19424 19425 +1
Branches 1318 1318
===============================================
+ Hits 19424 19425 +1
🚀 New features to boost your workflow:
|
|
BTW please make CI pass! |
|
Fixed! I've updated the type completeness checklist to remove the entries that are now resolved by the new docstrings. CI should pass now. |
|
Need to update type completeness file, you need to do |
|
Thanks @CoolCat467! I ran |
|
Thanks for the feedback @A5rocks @CoolCat467! I've rebased on upstream/main and am working on getting the type_completeness check to pass. The docstrings are present at runtime but pyright's |
Fixes #3221
Adds docstrings to the following public API items that were showing up without documentation:
MemorySendChannel— class docstring referencingopen_memory_channelMemoryReceiveChannel— class docstring referencingopen_memory_channelMemoryChannelStatistics— class docstring with attribute descriptionsSocketStream.send_all,wait_send_all_might_not_block,send_eof,receive_some,aclose— short docstrings referencing the parent ABC methodsHasFileno.fileno— method docstringParkingLot.broken_by— attribute docstringThe SocketStream method docstrings use
See :meth:...cross-references rather than duplicating the ABC documentation, keeping them in sync with the parent class.Tests run:
pytest src/trio/_tests/test_channel.py src/trio/_tests/test_highlevel_socket.py src/trio/_core/_tests/test_parking_lot.py— all pass.