Skip to main content

check-restated-results.yml

Diff-scoped, warn-only heuristic check for the lab’s rule (Ezra, 2026-10-29) that a result first derived in an exercise solution is restated in its own theorem-type div (#thm-, #lem-, #cor- or #prp-) after the exercise.

A #sol- div is a derivation when

The check follows {{< include >}} lines, so it reads a page in the order a reader sees it. It resolves an include as Quarto does, nested ones too, from the top-level page’s directory, and follows one that passes through a symlink, such as sds’s sds -> .. A file some page includes is not checked as a page of its own, and neither is the target of a commented-out include, such as an outtake no page renders. After a derivation solution, a theorem-type div has to appear before the next exercise of a different group. A group is the exercise slug with a trailing -partK or -partKb removed, and an exercise whose slug extends the group’s, such as exr-a-deviation (slug a-deviation) after exr-a (group a), continues it. A solution that holds <!-- restated-ok: reason --> is exempt.

The restating theorem is also flagged when its proof (a .proof div nested in it or directly after it) cites a solution (@sol-...) and displays no equation of its own, because a proof that only points back at the solution leaves the result unproved where it is stated. <!-- restated-ok: reason --> in the theorem or its proof exempts it. Whether the statement uses only defined symbols stays a review item.

A solution is checked when the pull request adds a line inside it or its exercise, and a proof when it adds a line inside the theorem or its proof. With no base to diff against, the check skips instead of scanning the whole tree, so existing solutions are fixed when someone edits them anyway. It warns by default; fail: true blocks.

Inputs

Input Default Meaning
globs *.qmd Git pathspecs of tracked files to check (recursive)
paths-ignore none Comma or newline separated globs to skip
fail false Fail on a finding; false warns
whole-tree false Check every derivation solution, to measure a corpus
python-version 3.x Python version
runs-on empty (CI_RUNNER variable, else ubuntu-latest) Runner label; a self-hosted label only for a private repository

Usage

Copy examples/check-restated-results.yml to .github/workflows/check-restated-results.yml.