Repository navigation
Document structured SIST results - #95
Merged
Merged
Conversation
5 tasks
harryswift01
changed the base branch from
main
to
96-feature-write-structured-json-results-from-sist
November 12, 2026 15:14
harryswift01
force-pushed
the
22-docs-document-structured-sist-results
branch
from
November 12, 2026 15:54
e7f9b70 to
85c1d29
Compare
Base automatically changed from
96-feature-write-structured-json-results-from-sist
to
main
November 16, 2026 15:42
harryswift01
force-pushed
the
22-docs-document-structured-sist-results
branch
from
November 16, 2026 16:32
85c1d29 to
895e73c
Compare
harryswift01
force-pushed
the
22-docs-document-structured-sist-results
branch
from
November 16, 2026 16:46
895e73c to
aa179cb
Compare
jimboid
approved these changes
Nov 17, 2026
jimboid
left a comment
Member
There was a problem hiding this comment.
A comprehensive documentation of the recently added features for data export. Happy to see this merge.
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
This PR adds a Structured Results page to the docs, explaining how to write a result with
sist --json, how to validate it, what it contains and how it relates to the text output. It also adds--jsonto the user guide. Closes #22.Changes
docs/source/result-format.rstand link it from the index as "Structured Results".--json, alone or alongside-o.sist-validateorResultValidator, and what the cross-checks add beyond the schema.--jsonto the options table and output section of the user guide.Testing
Impact
Checklist
pyproject.tomlchanged, the lower bounds were reviewed deliberately