docs(snapshot): scrub stale "verifier not shipped" wording - #554
Merged
kstonekuan merged 2 commits intoSep 16, 2026
Merged
kstonekuan merged 2 commits into
kstonekuan merged 2 commits into
Conversation
The integrity intro contradicted the same page's shipped verify section. Point the intro at hflow verify snapshot / verify_dataset_snapshot.
_build_snapshot_integrity_marker_fields still said "without a verifier product yet" after verify_dataset_snapshot shipped.
kstonekuan
approved these changes
Sep 16, 2026
kstonekuan
left a comment
Contributor
There was a problem hiding this comment.
LGTM, merging.
Catching the same stale claim in snapshot.py:251 ("without a verifier product yet"), not just the line the issue named, is the difference between fixing the report and fixing the problem. Nothing matching is left in docs/ or src/.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Align the dataset-snapshot how-to and the integrity exporter docstring with the shipped verifier (
hflow verify snapshot/verify_dataset_snapshot). Closes #553.Why
The export how-to introduced the
integrityblock as something a later verifier "(not shipped here)" would check, then documented runninghflow verify snapshota few paragraphs later. The exporter helper docstring still said "without a verifier product yet." That contradiction is leftover from before #457 / #473 / #469 landed.Two commits:
_build_snapshot_integrity_marker_fieldsatverify_dataset_snapshot.Validation
No behavior change; docs/docstring only. Pre-commit ruff clean on the Python touch.
Checklist
uv run ruff check --fix,uv run ruff format, anduv run ty check.