docs: generate the documented command line help from the parsers - #316
Merged
Conversation
The usage and option blocks in the README and the docs are the --help output of a command, which was edited by hand and had gone stale. The option lists for -fc and -cc were the choices removed when a version suffix was allowed, make-program listed zonbud3 rather than zonbud, and getting_started used the argparse heading from before python 3.10. The blocks are now written by scripts/update_docs.py, which is run with 'pixi run update-docs'. A test asserts the blocks match the parsers, so a change to an argument that is not documented fails. The parser for each command is split out of the function that runs it so that the help can be rendered without parsing arguments.
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## develop #316 +/- ##
=============================================
+ Coverage 79.671% 81.264% +1.593%
=============================================
Files 20 20
Lines 3591 3779 +188
=============================================
+ Hits 2861 3071 +210
+ Misses 730 708 -22
🚀 New features to boost your workflow:
|
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.
The usage and option blocks in the README and the docs are the
--helpoutput of a command, which was edited by hand and had gone stale: the-fc/-ccoption lists were the choices removed when a version suffix was allowed,make-programlistedzonbud3rather thanzonbud, andgetting_startedused the argparse heading from before python 3.10.The blocks are now written by
scripts/update_docs.py(pixi run update-docs), andtest_docs_currentasserts they match the parsers. The parser for each command is split out of the function that runs it so the help can be rendered without parsing arguments.