Repository navigation

Fail CI when a public API object is not documented - #79

Open

ocelotl wants to merge 10 commits into

mainfrom

docs_coverage_gate

Open

Fail CI when a public API object is not documented#79
ocelotl wants to merge 10 commits into
mainfrom
docs_coverage_gate

Commits on Oct 31, 2026
- scripts: add a docstring checker that compares a branch against main
  ocelotl
  committed
  b0bc6cd
- scripts: test the docstring checker
  ocelotl
  committed
  432452b
- tox: add the docstring-check environment
  ocelotl
  committed
  345d812
- workflows: run docstring-check on pull requests
  ocelotl
  committed
  00178c1
- docs: describe the docstring requirements and the check that enforces them
  ocelotl
  committed
  6a0198b
- changelog: add the fragment for the docstring check
  ocelotl
  committed
  5e53a12
- scripts: check every public API object, not only the ones a branch adds
  ocelotl
  committed
  f6cf150
- tox: pass posargs through to the docstring checker
  ocelotl
  committed
  d9e851c
- workflows: simplify the docstring-check job
  ocelotl
  committed
  5173ca4
- docs: describe the docstring check as absolute
  ocelotl
  committed
  1e18558