docs: widen the snapshot layer past grid state #222

Merged

natsukium merged 1 commit from feat/finite-option-values-187 into main 2026-09-08 03:09:55 +09:00

Conversation 0 Commits 1 Files changed 1 +4 -3

natsukium commented 2026-09-08 02:31:59 +09:00

Owner

Copy link

Fixes #187.

docs/reference/testing.md still defined the insta layer as "feeds bytes into the parser and grid, serializes the grid post-state". #187 added a checked-in golden for the CLI help pages, which is neither parser bytes in nor grid state out, so the normative reference no longer described what the layer holds — a contributor who reworded a --help string and hit a felis-cli snapshot failure would find no mention of that golden.

The change widens the definition to "serializes an output", retitles the table row to "Serialized output for representative inputs", and adds the CLI help pages to the categories list with the crate path and the .snap file name.

Doc cascade: reference-only. The explanation twin (docs/explanation/testing.md) argues why insta is used, not what it covers, and needed no edit; a grep sweep for "grid post-state" and "Cell-grid output" across docs/ found no other occurrence.

Verified: just check green (fmt, clippy, nextest, deny, proto-compat); reviewed by Claude correctness lens + Claude tests-docs lens; docs proofread by Gemini gemini-3.8-flash-high

Follow-ups

• #219 cli: duplicate #187 commits stacked on test/argv-matrix-185
• #220 test: only zsh pins the finite option values cli.md claims for every shell
• #221 cli: parse_region_source's error vocabulary can drift from SourceArg

Deferred

• Evidencing #55's two remaining closure criteria and closing the tracker — explicitly post-merge work on tracker #55, not code in this PR.
• Merged diff checked against acceptance criteria 1-4, no correctness defects found — positive confirmation only; no defect or unmet criterion is named, nothing to change in the code.

Fixes #187. `docs/reference/testing.md` still defined the insta layer as "feeds bytes into the parser and grid, serializes the grid post-state". #187 added a checked-in golden for the CLI help pages, which is neither parser bytes in nor grid state out, so the normative reference no longer described what the layer holds — a contributor who reworded a `--help` string and hit a `felis-cli` snapshot failure would find no mention of that golden. The change widens the definition to "serializes an output", retitles the table row to "Serialized output for representative inputs", and adds the CLI help pages to the categories list with the crate path and the `.snap` file name. Doc cascade: reference-only. The explanation twin (`docs/explanation/testing.md`) argues why insta is used, not what it covers, and needed no edit; a grep sweep for "grid post-state" and "Cell-grid output" across `docs/` found no other occurrence. Verified: just check green (fmt, clippy, nextest, deny, proto-compat); reviewed by Claude correctness lens + Claude tests-docs lens; docs proofread by Gemini gemini-3.8-flash-high ## Follow-ups - #219 cli: duplicate #187 commits stacked on test/argv-matrix-185 - #220 test: only zsh pins the finite option values cli.md claims for every shell - #221 cli: parse_region_source's error vocabulary can drift from SourceArg ## Deferred - Evidencing #55's two remaining closure criteria and closing the tracker — explicitly post-merge work on tracker #55, not code in this PR. - Merged diff checked against acceptance criteria 1-4, no correctness defects found — positive confirmation only; no defect or unmet criterion is named, nothing to change in the code.

natsukium added 1 commit 2026-09-08 02:31:59 +09:00

docs: widen the snapshot layer past grid state ... 93fe9ad024

The CLI help pages are now pinned by a checked-in insta snapshot, so the
reference definition of the snapshot layer — parser bytes in, grid
post-state out — no longer describes what the layer holds. A contributor
who reworded a --help string and got a felis-cli snapshot failure would
find no mention of that golden in the normative testing reference.

Refs #187

natsukium force-pushed feat/finite-option-values-187 from 93fe9ad024 to afea590f93 2026-09-08 02:38:36 +09:00 Compare

natsukium merged commit afea590f93 into main 2026-09-08 03:09:55 +09:00

natsukium deleted branch feat/finite-option-values-187 2026-09-08 03:09:55 +09:00

Sign in to join this conversation.

Reviewers

No reviewers

Labels

Clear labels   

priority/P0

Must be resolved before the v0.1.0 tag

  

priority/P1

Must be settled before the first public contract freezes

  

priority/P2

Explicitly deferred until after v0.1.0

  

release/v0.1.0

Work tracked for the first tagged release

  

status/blocked

Cannot start now: waits on an upstream release, another issue, or a recorded revisit trigger

  

status/planned

Triaged with a source-grounded plan and a passed pi review; ready to implement

  

type/bug

Shipped behavior that contradicts the docs or the code's own intent; needs a product code change

  

type/design

An open scope or trade-off question; needs a recorded decision in the owning explanation doc before code

  

type/test-gap

Documented or reviewed behavior that no test pins; usually split from a review finding, needs no product code change

  

type/tracker

Parent issue that tracks child work

No labels

priority/P0

priority/P1

priority/P2

release/v0.1.0

status/blocked

status/planned

type/bug

type/design

type/test-gap

type/tracker

Milestone

Clear milestone

No items

No milestone

Projects

Clear projects

No items

No project

Assignees

Clear assignees

No assignees

1 participant

Notifications

Subscribe

Due date

The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set

Reference

natsukium/felis!222

No description provided.