From ba9c99ccd5336d4d5ff82153ca66d1196ae9f0d5 Mon Sep 17 00:00:00 2001 From: madhur dhillon Date: Mon, 29 Jun 2026 22:44:01 +0530 Subject: [PATCH] Remove undocumented SocketStream members from docs --- docs/source/conf.py | 5 ----- docs/source/reference-io.rst | 5 ++--- 2 files changed, 2 insertions(+), 8 deletions(-) diff --git a/docs/source/conf.py b/docs/source/conf.py index 5017f3895e..925c31e8ef 100755 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -176,11 +176,6 @@ def autodoc_process_signature( "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", } diff --git a/docs/source/reference-io.rst b/docs/source/reference-io.rst index 665f62dd0b..d1eb083b08 100644 --- a/docs/source/reference-io.rst +++ b/docs/source/reference-io.rst @@ -218,7 +218,6 @@ abstraction. .. autoclass:: SocketStream :members: - :undoc-members: :show-inheritance: .. autoclass:: SocketListener @@ -431,8 +430,8 @@ Socket objects socket. * :meth:`~socket.socket.sendall`: Could be supported, but you're better off using the higher-level - :class:`~trio.SocketStream`, and specifically its - :meth:`~trio.SocketStream.send_all` method, which also does + :class:`~trio.SocketStream`, and specifically the + :meth:`~trio.abc.SendStream.send_all` method, which also does additional error checking. In addition, the following methods are similar to the equivalents