-
Notifications
You must be signed in to change notification settings - Fork 2.4k
Open
Labels
area:cliCLI functionalityCLI functionalitydocumentationImprovements or additions to documentationImprovements or additions to documentationenhancementNew feature or requestNew feature or requestgood first issueGood for newcomersGood for newcomersmedium-priorityImportant but not urgentImportant but not urgent
Description
Summary
Follow-up to #1594. The current help sync test only checks if commands exist in help documentation, not if their subcommands/options are correctly documented.
Problem
PR #1593 fixed outdated help documentation where:
tagsshowed old commands (add-tag,use-tag) instead of new subcommand structure (tags add,tags use)listwas missing new options (--watch,--ready,--blocking)
The test in #1595 wouldn't catch these issues because it only verifies command existence.
Proposed Enhancement
Add verification that:
tagssubcommands are documented (tags add,tags use,tags remove,tags rename,tags copy,tags list)- Key command options are documented (e.g.,
listshows--watch,--ready,--blocking)
Dependencies
- Requires docs: Update help command with current tags and list options #1593 to be merged first (or branch from it)
Related
- Help command shows outdated tag commands and missing list options #1588 - Original help outdated issue
- docs: Update help command with current tags and list options #1593 - Fix for outdated help
- Add lint/test to ensure help documentation stays in sync with commands #1594 - Original test issue
- test: Add test to ensure help documentation stays in sync with CLI commands #1595 - Basic help sync test PR
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
area:cliCLI functionalityCLI functionalitydocumentationImprovements or additions to documentationImprovements or additions to documentationenhancementNew feature or requestNew feature or requestgood first issueGood for newcomersGood for newcomersmedium-priorityImportant but not urgentImportant but not urgent