Skip to content

docs(examples): stop READMEs saying smoke skips the flag CI runs as the falsifier - #415

Merged
TMHSDigital merged 2 commits into
mainfrom
docs/readme-falsifier-lines
Oct 5, 2026
Merged

TMHSDigital merged 2 commits into
mainfrom
docs/readme-falsifier-lines

Conversation

@TMHSDigital

@TMHSDigital TMHSDigital commented Oct 4, 2026 •

Copy link
Copy Markdown
Owner

Closes #359.

Problem

Since falsifiers started running in CI (#320), 57 example READMEs still said "Smoke does not pass --x" for the very flag tests/smoke/catalog.json runs as that example's falsifier. bmesh-gear, the anatomy file every new example copies, was one of them.

Change

  • 54 READMEs were rewritten by a script, plus 2 by hand (gn-modifier-inputs, sky-texture-sun-elevation); gn-bundle-roundtrip was already fixed in fix(examples): give gn-bundle-roundtrip a falsifier that can fail #408. The line now:

    • names only the flags smoke really skips;
    • appends Its catalog falsifier is --x (expects exit N).;
    • adds "5.2+ only; SKIP on older Blender" when the falsifier carries min_version.

    This matches the four READMEs that were already correct.

  • tests/check_smoke_catalog.py: a new check_readme_claims() fails when a README's "does not pass" clause names its own row's falsifier flag. Validate already runs this script.

Example:

-Smoke does not pass `--output` or `--no-extrude`.
+Smoke does not pass `--output`. Its catalog falsifier is `--no-extrude` (expects exit 3).

Evidence (local, Python 3.13; no Blender needed)

🤖 Generated with Claude Code

…he falsifier

Since falsifiers started running in CI (#320), 57 example READMEs still
said "Smoke does not pass `--x`" for the very flag the catalog runs as
that example's falsifier, and bmesh-gear (the anatomy every new example
copies) was one of them. The line now names only the flags smoke really
skips and states the catalog falsifier with its expected exit, matching
the four READMEs that already did.

check_smoke_catalog.py now fails when a README's "does not pass" clause
names its own row's falsifier flag, so the drift cannot return.

Closes #359

Signed-off-by: TMHSDigital <154358121+TMHSDigital@users.noreply.github.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@github-actions github-actions Bot added examples Runnable smoke-gated examples under examples/ documentation Improvements or additions to documentation labels Oct 4, 2026
Signed-off-by: TMHSDigital <154358121+TMHSDigital@users.noreply.github.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@TMHSDigital

Copy link
Copy Markdown
Owner Author

CI evidence before merge: all checks pass ( 13 pass ). Blender Smoke on PR head: Blender 5.2.2 LTS / Blender 4.5.14 LTS. Summaries (happy path; falsifiers) per leg: 143 passed, 1 skipped, 0 failed;142 passed, 0 skipped, 0 failed;141 passed, 3 skipped, 0 failed;136 passed, 6 skipped, 0 failed;

@TMHSDigital
TMHSDigital merged commit 2cdde2c into main Oct 5, 2026
13 checks passed
@TMHSDigital
TMHSDigital deleted the docs/readme-falsifier-lines branch October 5, 2026 00:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation examples Runnable smoke-gated examples under examples/

Projects

None yet

Development

Successfully merging this pull request may close these issues.

examples: 60 of 64 READMEs say smoke 'does not pass' the flag CI actually runs as the falsifier

1 participant