@@ -168,7 +168,21 @@ def autodoc_process_signature(
168
168
return signature , return_annotation
169
169
170
170
171
+ # currently undocumented things
171
172
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
+ }
172
186
173
187
174
188
def autodoc_process_docstring (
@@ -180,7 +194,14 @@ def autodoc_process_docstring(
180
194
lines : list [str ],
181
195
) -> None :
182
196
if not lines :
197
+ # TODO: document these and remove them from here
198
+ if name in UNDOCUMENTED :
199
+ return
200
+
183
201
logger .warning (f"{ name } has no docstring" )
202
+ else :
203
+ if name in UNDOCUMENTED :
204
+ logger .warning ("outdated list of undocumented things" )
184
205
185
206
186
207
# XX hack the RTD theme until
0 commit comments