Skip to content

docs(validation): document the fault status in the how-to #152

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
simontaurus merged 1 commit into from
Sep 11, 2026
Merged

docs(validation): document the fault status in the how-to #152

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion docs/how-to/validation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,13 @@ instance of the document it names, and a file with no `$schema` at all needs `--
`--as-instance` to say which it is. Pass either flag to skip detection and force one reading, for
example when a schema is still being drafted and has no `$schema` yet.

Exit code is 0 only when no check failed. Warnings do not fail a run.
Exit code is 0 only when no check failed and none faulted. Warnings do not fail a run.

A **fault** is a defect in this validator rather than a finding about your document: a check
raised something it does not expect, so it produced no verdict and the document is neither
condemned nor cleared. It carries the id of the check that broke, is counted separately from
failures, and stops that one check rather than the run - every other target still reports. Seeing
one means filing a bug here, not editing your schema.

### Options

Expand Down
Loading