Skip to content

Document the version and summary.ungraded keys in saved results - #137

Open
avalyset wants to merge 2 commits into
SimulaMet:devfrom
avalyset:docs/readme-json-keys
Open

avalyset wants to merge 2 commits into
SimulaMet:devfrom
avalyset:docs/readme-json-keys

Conversation

@avalyset

@avalyset avalyset commented Nov 3, 2026

Copy link
Copy Markdown
Contributor

#132 added a top-level "version": "1.0" to AuditResults.to_dict(), and #135 added summary.ungraded. The README explains the ungraded count but does not say that save() writes it, and it does not mention version.

This adds one paragraph covering both keys under "Understanding Results", next to the existing paragraph on passed + failed + errors + ungraded. Nothing else changes.

The rule for version comes from #114: "bumped explicitly whenever the serialized shape changes".

AI disclosure: implemented with Claude Code.

The README described the ungraded count but not that save() writes it,
nor the top-level version key. A reader of the file now finds both next
to the paragraph that already explains passed, failed, errors and
ungraded.
The code records "1.0" but has no rule for bumping it, and saved results
now carry an optional per-result expectations field under the same
version. Keep the statement to what the code does.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant