python-trio/trio

Some functions and properties in the documentation have no docstring

Open

#3221 opened on Mar 10, 2025

View on GitHub
 (8 comments) (0 reactions) (0 assignees)Python (5,479 stars) (310 forks)batch import
docsgood first issue

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

Tech stack
python
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
PythonTrio librarydocstring conventions
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65
Research direction
The missing docstrings are for functions and properties listed in the issue body, such as `trio.MemorySendChannel`, `trio.SocketStream`, etc. To add documentation, look at the source code in the `trio` package (e.g., `trio/ socket.py`, `trio/ channel.py`) and follow existing docstring patterns. The issue also references #3010 for `relative deadline`. Ensure that the docstrings are informative and match the style used elsewhere.