Skip to content

Add docstring for SocketStream.send_all #3458

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
A5rocks merged 1 commit into from
Jun 30, 2026
+2 −8
Merged

Add docstring for SocketStream.send_all #3458

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 0 additions & 5 deletions docs/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
}
Expand Down
5 changes: 2 additions & 3 deletions docs/source/reference-io.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -218,7 +218,6 @@ abstraction.

.. autoclass:: SocketStream
:members:
:undoc-members:
:show-inheritance:

.. autoclass:: SocketListener
Expand Down Expand Up @@ -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
Expand Down
Loading