Skip to content

scripts/check_docs.py has no test coverage of its own #97

Closed

Description

@dmccoystephenson

What's missing

scripts/check_docs.py's entire job is catching documentation drift mechanically (placeholder-table sync,
README/Step 1:1 sync, local link resolution), but the script itself has no test suite. A future edit that
silently breaks one of its three checks (e.g. a regex tweak that stops matching anything) would read as
"0 errors -> pass" in CI, giving false confidence.

Suggested fix

Add a couple of fixture-based smoke tests: a known-good doc set that should exit 0, and 2-3 known-broken doc
sets (missing placeholder row, README/Step count mismatch, a dangling relative link) that should each exit
non-zero with a clear message. Doesn't need a test framework — stdlib unittest keeps the script's
zero-dependency property.

Provenance

Found during a public-readiness review ahead of this repo's planned public flip, 2026-08-02.

Activity

  1. added a commit that references this issue on Aug 3, 2026
    6037cf3
  2. added a commit that references this issue on Aug 3, 2026
    f879b19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions