collective / icalendar / 30758313053

98%

push

github

docs: avoid false section headings in public docstrings (#1482)

* test: add public docstring heading check

Add an AST-based regression test that accepts a specific allowlist of public docstring section headings and reports unsupported headings with a focused error message. Also adjust a few existing docstrings so prose/example lead-in lines are not shaped like unsupported section headings.

AI assistance: OpenAI Codex (GPT-5) helped identify the narrow regression-test approach, draft the test and changelog wording, and review focused verification output. The contributor reviewed the implementation and verification before submission.

* test: build docstring checks on merged baseline

---------

Co-authored-by: Steve Piercy <web@stevepiercy.com>

847 of 869 branches covered (97.47%)

Branch coverage included in aggregate %.

13854 of 14132 relevant lines covered (98.03%)

6.86 hits per line