2.3 KiB
Prompt
Same /code-review follow-up session (PR #460). Finding #10: the new api/ autodoc reference pages surfaced 22 docutils warnings sourced from informal reST in public docstrings. The user opted to fix it on this branch,
well we’re on a clean main so why not just do these now too?
Goal: drive the docs build warning-free (24 -> 0) without any code/behaviour change — docstring content only.
Response summary
Surgical docstring-RST lint across 9 library modules + the one offending NEWS.rst changelog entry,
- bullet lists given a blank line + base-column indent (
Context,Context.cancel_called/.cancelled_caught/.outcome,ActorNursery.cancel_called,query_actor,open_crash_handler, the#318NEWS.rstentry), - the under-short
Behaviour:underline inContext.canceldemoted to a**bold**label, - unbalanced/pluralized-role backticks fixed — closed the
wait_for_actorsummary backtick; applied the`role`\ sescaped-plural idiom ingather_contexts,mk_pdb,MsgCodec, msgError,open_context_from_portal, - the
|_method-tree inContextCancelled.cancellermade a literal block (bare|was parsed as a substitution ref).
Verified: build 24 -> 0 warnings; import tractor clean under -W error::SyntaxWarning; the \ s idiom renders as e.g. “acms” (no backslash/space leak in HTML); ruff clean; diff confirmed docstring-content-only.
Initial generation was delegated to a constrained subagent (docstring-only edits + a rebuild-to-zero verification gate); the orchestrator independently re-built, reviewed the full diff, and added the NEWS.rst fix to reach zero.
Files changed
tractor/_context.py,tractor/_exceptions.py,tractor/devx/debug/_post_mortem.py,tractor/devx/debug/_repl.py,tractor/discovery/_api.py,tractor/msg/_codec.py,tractor/msg/types.py,tractor/runtime/_supervise.py,tractor/trionics/_mngrs.py— docstring reST fixes,NEWS.rst— blank line before a bullet list in the#318entry.
Human edits
None — committed as generated (0a3c48fc).