python-trio/trio
在 GitHub 查看Some functions and properties in the documentation have no docstring
Open
#3,221 建立於 2025年3月10日
docsgood first issue
倉庫指標
- Star
- (5,479 star)
- PR 合併指標
- (平均合併 14小時 5分鐘) (30 天內合併 6 個 PR)
描述
The following things lack documentation in Trio's documentation:
-
trio.CancelScope.relative_deadline -
trio.MemorySendChannel -
trio.MemoryReceiveChannel -
trio.MemoryChannelStatistics -
trio.SocketStream.aclose -
trio.SocketStream.receive_some -
trio.SocketStream.send_all -
trio.SocketStream.send_eof -
trio.SocketStream.wait_send_all_might_not_block -
trio._subprocess.HasFileno.fileno -
trio.lowlevel.ParkingLot.broken_by
These should either have documentation or not show up (e.g. the SocketStream attributes seem unnecessary, they're only in the docs because of a :undoc-members:).
At https://trio.readthedocs.io/en/latest/reference-core.html#trio.CancelScope.relative_deadline, there is no definition of the semantics of relative_deadline. Looks like it was added in #3010.