Generate the question-format tables from the export - #53
Merged
Merged
Conversation
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.
docs/source/question-format.md (t10) describes the JSON key by key in four hand-written tables. Nothing checks them, so when the Lambda Feedback schema changes the writer and the fixture get updated, CI passes, and the page quietly describes the old schema.
Make the tables come from the data. At docs build, generate the set, question, part and response-area key tables from the real export in tests/fixtures/exports (key, type, an example value), the way docs/source/filters.py already generates the filters page. Meanings cannot be generated: keep a dict of one-line notes per key beside the generator, and add a test that every key the export carries has a note, so a schema change fails CI until the one line is written. Keep the executable example and the Markdown section as they are.
Done when the four tables on the built page match the fixture export with no hand-written rows, and adding a made-up key to a copy of the export makes the test name it.
Workbench ticket t33.