Skip to content

docs: drop undocumented SocketStream method stubs from the API ref #3439

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

Closed
mokashang wants to merge 1 commit into from
+5 −7
Closed

docs: drop undocumented SocketStream method stubs from the API ref #3439

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
3 changes: 1 addition & 2 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 @@ -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
Expand Down
4 changes: 4 additions & 0 deletions newsfragments/3221.doc.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.
Loading