docs: sync cli.py usage docstring with actual flags - #174
Merged
Conversation
The module docstring's Usage block omitted --list-domains, --list-domains --json, and --log-level, all of which are real arguments. Add them so the in-file summary matches the parser.
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.
Summary
The
src/cli.pymodule docstring'sUsage:block was missing three flags that the argument parser actually supports:--list-domains,--list-domains --json, and--log-level. This syncs the in-file usage summary with the real parser. Docstring-only; no behaviour change.Changes
src/cli.py: add the three missing flags to the module-docstringUsage:block.CHANGELOG.md:[Unreleased]Documentation entry.Related Issues
None.
Testing
pytest tests/test_cli.py -q- 17 passedblack --check src/cli.pypassesflake8 src/cli.pypasses under the project config (--max-line-length=100)