docs: align README human output with printHuman fields - #7
Merged
Conversation
The pass-path sample omitted prove_scenario, prove_triggered_by, and the run-bundle path that the CLI always prints. Add JSDoc for the report shape and lock the README sample against printHuman.
![devin-ai-integration[bot]](https://avatars.githubusercontent.com/in/811515?s=60&v=4){kind=small}
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
1 participant
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.
What
The pass-path sample in README.md was missing fields that
aas demoalways prints:prove_scenarioprove_triggered_bybundleJSDoc now documents the run report / stage types used by the CLI, and a test compares the README sample to
printHumanso the documented field order cannot drift.Why
The README is the user-facing contract for CLI output. Following it today would omit three lines the orchestrator actually emits.
How tested
npm test(27 passing, including the new README/printHumanlock)node --checkonbin/aas.mjs,bin/aas-gui.mjs,scripts/bootstrap.mjs, and both test files