[uss_qualifier] Improve action generator & test suite documentation #194
Conversation
This file contains 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
Shastick
added a commit
to Orbitalize/monitoring
that referenced
this pull request
Sep 11, 2023
BenjaminPelletier
pushed a commit
that referenced
this pull request
Sep 11, 2023
Cherry-pick Ben's CI fix from #194
barroco
approved these changes
Sep 12, 2023
BenjaminPelletier
deleted the
feature/action-generator-documentation
branch
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.
This PR expands on test suite documentation autogeneration by treating action generators more effectively, and including in-suite test suite definitions.
It also adds a table of checked requirements for each suite along with their implementation status (populated from
TODO:notes in test check documentation). To verify this functionality, the planned check for ASTM F3411-22a NET0240 is added to the appropriate test scenario, and that NET0240 check is correctly shown as "Planned" in the appropriate test suite documentation.