Skip to content

Commit d4926bb

Browse files
committed
docs(doctest_docutils[_make_runner]): Add NumPy-style Parameters/Returns
why: Comply with project docstring standards what: - Add Parameters section documenting debug and loop_factory - Add Returns section documenting return type
1 parent 739bfcc commit d4926bb

1 file changed

Lines changed: 12 additions & 0 deletions

File tree

src/doctest_docutils.py

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -144,6 +144,18 @@ def _make_runner(
144144
145145
Returns asyncio.Runner on Python 3.11+, or _Runner310 shim on 3.10.
146146
Both have compatible interfaces (context manager with run() method).
147+
148+
Parameters
149+
----------
150+
debug : bool | None, optional
151+
Enable event loop debug mode, by default None
152+
loop_factory : Callable[[], AbstractEventLoop] | None, optional
153+
Factory function to create custom event loops, by default None
154+
155+
Returns
156+
-------
157+
_Runner310
158+
Context manager with run() method for executing coroutines
147159
"""
148160
Runner = getattr(asyncio, "Runner", None)
149161
if Runner is not None:

0 commit comments

Comments
 (0)