fix: address review feedback - update conf.py, add newsfragment, fix type completeness json

nightcityblade · nightcityblade · commit dcfa30426e69 · 2026-03-26T11:04:17.000+08:00
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -173,15 +173,6 @@ def autodoc_process_signature(
 # currently undocumented things
 logger = getLogger("trio")
 UNDOCUMENTED = {
-    "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/newsfragments/3221.doc.rst b/newsfragments/3221.doc.rst
@@ -0,0 +1 @@
+Added missing docstrings for public API classes and methods.
diff --git a/src/trio/_tests/_check_type_completeness.json b/src/trio/_tests/_check_type_completeness.json
@@ -1,6 +1,5 @@
 {
     "Darwin": [
-        "No docstring found for class \"trio._core._io_kqueue._KqueueStatistics\"",
         "No docstring found for function \"trio._unix_pipes.FdStream.send_all\"",
         "No docstring found for function \"trio._unix_pipes.FdStream.wait_send_all_might_not_block\"",
         "No docstring found for function \"trio._unix_pipes.FdStream.receive_some\"",

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+Added missing docstrings for public API classes and methods.`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,5 @@`
`1`	`1`	`{`
`2`	`2`	`"Darwin": [`
`3`		`- "No docstring found for class \"trio._core._io_kqueue._KqueueStatistics\"",`
`4`	`3`	`"No docstring found for function \"trio._unix_pipes.FdStream.send_all\"",`
`5`	`4`	`"No docstring found for function \"trio._unix_pipes.FdStream.wait_send_all_might_not_block\"",`
`6`	`5`	`"No docstring found for function \"trio._unix_pipes.FdStream.receive_some\"",`