-
Notifications
You must be signed in to change notification settings - Fork 2
Add help text to CLI options missing descriptions #30
Copy link
Copy link
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationgood first issueGood for newcomersGood for newcomers
Description
Problem
Several Click options across 4 commands have no help= parameter. When users run nboot <command> --help, these options appear with no description:
| Command | Options missing help text |
|---|---|
validate |
--spec, --pack |
render |
--spec, --pack, --out, --dry-run |
apply |
--spec, --pack, --dry-run |
diff |
--spec, --pack |
By contrast, --skip-resolve and --trust already have help strings, and the new / init commands are fully documented.
Fix
Add help="..." strings to each option in src/navi_bootstrap/cli.py. Examples:
@click.option("--spec", required=True, type=click.Path(exists=True, path_type=Path), help="Path to the project spec YAML file")
@click.option("--pack", required=True, type=str, help="Name of the template pack to render")
@click.option("--out", type=click.Path(path_type=Path), default=None, help="Output directory (defaults to spec name)")
@click.option("--dry-run", is_flag=True, default=False, help="Preview output without writing files")Keep descriptions short and consistent across commands where options repeat (e.g. --spec and --pack appear in all 4 commands).
Files to change
src/navi_bootstrap/cli.py
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationgood first issueGood for newcomersGood for newcomers