python-trio / python-trio/trio
Some functions and properties in the documentation have no docstring
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 7.3k
- Forks
- 431
- Avg merge
- 2d 17h
- Merged PRs (30d)
- 6
Description
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.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start at the Trio API documentation for the two unchecked members, especially reference-core.html#trio.CancelScope.relative_deadline, and inspect how the listed objects are exposed through undoc-members. Decide which entries need documented semantics and which should be hidden; done means the remaining API pages either explain the members or no longer show them.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100