Repository navigation
Name every get-todos --json field with its type in help and docs - #130
Merged
Merged
Conversation
The --help epilog left out hash, which the command reference listed, and neither text gave a type: references is a list of page names as strings, and a caller that read it as objects failed. Both texts now name each field with its type and say how references is ordered. A test takes the keys from real get-todos --json output and checks that the --json paragraph of the help and of the reference row names each one, so a new field fails until both texts have it. docs/design.md said references names the days a task was carried into; it names pages, ordinary pages included.
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
The
--helpepilog and theget-todosrow indocs/commands.mdname every--jsonfield with its type. The epilog had left outhash. A caller readreferencesas a list of objects and failed; it is a list of page names as strings.docs/design.mdsaidreferencesnames days; it names pages.Closes #129
Evidence
tests/test_get_todos_fields_documented.pyagainst the old texts is red: the help misseshash, the reference row missestodosandcount.After: green. Full suite 4049 passed, 8 skipped;
ruffclean.Removing any of the 15 keys from either text turns the test red (30 of 30).
Merge Danger
Door: two-way
Help text, docs and one test. The
--jsonoutput does not change.Blast Radius: none