python-trio/trio

Some functions and properties in the documentation have no docstring

Open

#3,221 opened on 2025年3月10日

GitHub で見る
 (8 comments) (0 reactions) (0 assignees)Python (5,479 stars) (310 forks)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
Issue 種別
documentation
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
3
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
half day
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
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.