Properly document statistics object

python-trio · Oct 5, 2024 · 443813e · 443813e
1 parent 25be18c
commit 443813e
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 4 deletions.
diff --git a/docs/source/reference-core.rst b/docs/source/reference-core.rst
@@ -1241,6 +1241,8 @@ more features beyond the core channel interface:
 .. autoclass:: MemoryReceiveChannel
    :members:
 
+.. autoclass:: MemoryChannelStats
+   :members:
 
 A simple channel example
 ++++++++++++++++++++++++

diff --git a/src/trio/__init__.py b/src/trio/__init__.py
@@ -27,6 +27,7 @@
 from ._channel import (
     MemoryReceiveChannel as MemoryReceiveChannel,
     MemorySendChannel as MemorySendChannel,
+    MemoryChannelStats as MemoryChannelStats,
     open_memory_channel as open_memory_channel,
 )
 from ._core import (

diff --git a/src/trio/_tests/_check_type_completeness.json b/src/trio/_tests/_check_type_completeness.json
@@ -20,13 +20,9 @@
     "all": [
         "No docstring found for class \"trio.MemoryReceiveChannel\"",
         "No docstring found for class \"trio._channel.MemoryReceiveChannel\"",
-        "No docstring found for function \"trio._channel.MemoryReceiveChannel.statistics\"",
         "No docstring found for class \"trio._channel.MemoryChannelStats\"",
-        "No docstring found for function \"trio._channel.MemoryReceiveChannel.aclose\"",
         "No docstring found for class \"trio.MemorySendChannel\"",
         "No docstring found for class \"trio._channel.MemorySendChannel\"",
-        "No docstring found for function \"trio._channel.MemorySendChannel.statistics\"",
-        "No docstring found for function \"trio._channel.MemorySendChannel.aclose\"",
         "No docstring found for class \"trio._core._run.Task\"",
         "No docstring found for class \"trio._socket.SocketType\"",
         "No docstring found for function \"trio._highlevel_socket.SocketStream.send_all\"",