docs: drop undocumented SocketStream method stubs from the API ref#3439
docs: drop undocumented SocketStream method stubs from the API ref#3439mokashang wants to merge 1 commit into
Conversation
| trio.ClosedResourceError: if :meth:`send_eof` has already been called | ||
| on this stream, or if the underlying socket has been closed. | ||
|
|
||
| """ |
There was a problem hiding this comment.
No, this shouldn't be necessary! Try removing :undoc-members:.
|
FYI I have no patience for LLM-generated PR descriptions. Please either write your responses yourself, or I'll close this PR. |
These five overrides on SocketStream had no docstring of their own, so they appeared in the SocketStream autodoc table as bare entries because of `:undoc-members:`. Remove that directive so the autoclass directive only lists members that actually have content (`setsockopt`, `getsockopt`, the `socket` attribute). Users following the inheritance chain still get the canonical contracts on the trio.abc classes. Update the cross-reference in the socket section to point at `trio.abc.SendStream.send_all` since `trio.SocketStream.send_all` no longer has a documented target, and prune the now-dead entries from `UNDOCUMENTED` in conf.py. Refs python-trio#3221.
mokashang
force-pushed
the
docs/socketstream-docstrings
branch
from
755eb46 to
becb825
Compare
mokashang
changed the title
|
Switched to that approach — pushed a new commit that drops On the previous description — fair point, I'll keep these terser. |
2 participants
Per A5rocks's review, this now removes
:undoc-members:from theSocketStreamautoclass directive instead of adding docstrings. The five overrides (send_all,wait_send_all_might_not_block,send_eof,receive_some,aclose) no longer show up as empty rows in the API table; users follow the inheritance link to thetrio.abccontracts.Two extras that fell out of doing it that way: the cross-reference further down in
reference-io.rstpointed attrio.SocketStream.send_all, which no longer has a target, so it now points attrio.abc.SendStream.send_all; and the five matching entries inUNDOCUMENTEDinconf.pywere silencing warnings for things that aren't autodoc'd anymore, so I removed them too.make htmlruns clean with-W. Refs #3221.