Skip to content

Commit 8f8641c

Browse files
committed
Add a set of things that are currently incorrect
This way we can have a one-way ratchet!
1 parent 253ee2e commit 8f8641c

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

docs/source/conf.py

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -168,7 +168,21 @@ def autodoc_process_signature(
168168
return signature, return_annotation
169169

170170

171+
# currently undocumented things
171172
logger = getLogger("trio")
173+
UNDOCUMENTED = {
174+
"trio.CancelScope.relative_deadline",
175+
"trio.MemorySendChannel",
176+
"trio.MemoryReceiveChannel",
177+
"trio.MemoryChannelStatistics",
178+
"trio.SocketStream.aclose",
179+
"trio.SocketStream.receive_some",
180+
"trio.SocketStream.send_all",
181+
"trio.SocketStream.send_eof",
182+
"trio.SocketStream.wait_send_all_might_not_block",
183+
"trio._subprocess.HasFileno.fileno",
184+
"trio.lowlevel.ParkingLot.broken_by",
185+
}
172186

173187

174188
def autodoc_process_docstring(
@@ -180,7 +194,14 @@ def autodoc_process_docstring(
180194
lines: list[str],
181195
) -> None:
182196
if not lines:
197+
# TODO: document these and remove them from here
198+
if name in UNDOCUMENTED:
199+
return
200+
183201
logger.warning(f"{name} has no docstring")
202+
else:
203+
if name in UNDOCUMENTED:
204+
logger.warning("outdated list of undocumented things")
184205

185206

186207
# XX hack the RTD theme until

0 commit comments

Comments
 (0)