Add first-class help text to plexadm CLI#19
Merged
Conversation
Expand every argparse subparser and argument with descriptions, per-argument help, metavars, and command-group epilogs with concrete examples. Switch all parsers to RawDescriptionHelpFormatter so multi-line descriptions render. Modeled on the AWS CLI v2 help: each command/subcommand now reports what it does and shows a worked example, and every flag/positional argument carries explanatory text instead of bare option names. Closes #2. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
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
plexadmargparse subparser with descriptions, per-argument help, metavars, and command-group epilogs with concrete examples.RawDescriptionHelpFormatterso multi-line descriptions render.Tracked in Odoo task #174. Closes #2.
Test plan
make lintfix && make lintclean (ruff + mypy)make testpasses (4/4)plexadm --help,plexadm list --help,plexadm collection add-title --help,plexadm top --helprendered locally and read sensibly