python-trio/trio

Some functions and properties in the documentation have no docstring

Open

#3,221 建立於 2025年3月10日

在 GitHub 查看
 (8 留言) (0 反應) (0 負責人)Python (5,479 star) (310 fork)batch import
docsgood first issue

描述

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.

貢獻者指南

技術棧
python
領域
documentation
議題類型
documentation
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
3
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
half day
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
active
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
PythonTrio librarydocstring conventions
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
65
研究方向
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.
Some functions and properties in the documentation have no docstring · python-trio/trio#3221 | Good First Issue