diff --git a/docs/source/conf.py b/docs/source/conf.py index 5017f3895..925c31e8e 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 665f62dd0..9d55ec819 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 @@ -432,7 +431,7 @@ Socket objects * :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 + :meth:`~trio.abc.SendStream.send_all` method, which also does additional error checking. In addition, the following methods are similar to the equivalents diff --git a/newsfragments/3221.doc.rst b/newsfragments/3221.doc.rst new file mode 100644 index 000000000..282813c03 --- /dev/null +++ b/newsfragments/3221.doc.rst @@ -0,0 +1,4 @@ +Stopped listing :class:`trio.SocketStream`'s undocumented overrides of +``send_all``, ``wait_send_all_might_not_block``, ``send_eof``, ``receive_some``, +and ``aclose`` in the API reference. The base contracts on the +:mod:`trio.abc` classes remain the canonical reference.