Skip to content

Add docstrings to 8 nested test helpers to restore 100% docs coverage #64

Description

@tschm

Subcategory: Docstring / API-doc coverage
Score: 8 → 10

make docs-coverage runs interrogate --fail-under 100, so any missing docstring fails the gate. Coverage is currently 97.4%. All 8 gaps are nested helper classes/functions defined inside test bodies — src/ is fully documented.

What to change

  • tests/pycharting/api/test_interface.py:163class _Event
  • tests/pycharting/api/test_interface.py:167_Event.is_set
  • tests/pycharting/api/test_interface.py:171_Event.wait
  • tests/pycharting/api/test_interface.py:191class _InterruptingEvent
  • tests/pycharting/api/test_interface.py:192_InterruptingEvent.is_set
  • tests/pycharting/api/test_interface.py:195_InterruptingEvent.wait
  • tests/pycharting/core/test_lifecycle.py:284def _healthy
  • tests/pycharting/core/test_lifecycle.py:305def _healthy

done when

make docs-coverage reports 100.0% and exits 0.

Evidence

RESULT: FAILED (minimum: 100.0%, actual: 97.4%)
| test_plot_block_returns_when_shutdown_event_set._Event (L163)  |  MISSED |

Surfaced by the Rhiza quality gates during the template bump to jebel-quant/rhiza@v1.2.2, which enabled the stricter ruff rule families (ANN, A, BLE, ARG) and TYPECHECKER=both. Gate status at time of filing: make fmt FAIL, make typecheck FAIL, make docs-coverage FAIL, test-layout FAIL; make deptry, make security, make test PASS (154 tests, 100% coverage).

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions