docs: add help text to CLI options#41
docs: add help text to CLI options#41Nelson Spence (Fieldnote-Echo) wants to merge 1 commit intomainfrom
Conversation
Add help text to CLI options missing descriptions in validate, render, apply, and diff commands. Closes #30 Co-Authored-By: passionworkeer <passionworkeer@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Adds missing Click help= strings for common CLI options so nboot <command> --help shows descriptions for validate, render, apply, and diff commands (addresses #30).
Changes:
- Add
help=text for--spec/--packinvalidate - Add
help=text for--spec/--pack/--out/--dry-runinrender - Add
help=text for--spec/--pack/--dry-runinapplyand for--spec/--packindiff
| "--spec", | ||
| required=True, | ||
| type=click.Path(exists=True, path_type=Path), | ||
| help="Path to the project spec YAML file", | ||
| ) |
There was a problem hiding this comment.
The new --spec help text says "YAML", but load_spec() loads JSON (see src/navi_bootstrap/spec.py), and init writes nboot-spec.json. This will mislead users; update the help string to reference a JSON spec file (or broaden it only if YAML is actually supported).
| "--spec", | ||
| required=True, | ||
| type=click.Path(exists=True, path_type=Path), | ||
| help="Path to the project spec YAML file", | ||
| ) |
There was a problem hiding this comment.
The new --spec help text says "YAML", but this command calls load_spec() which parses JSON specs. Update the help string to reference a JSON spec file to match actual behavior.
| "--spec", | ||
| required=True, | ||
| type=click.Path(exists=True, path_type=Path), | ||
| help="Path to the project spec YAML file", | ||
| ) |
There was a problem hiding this comment.
The new --spec help text says "YAML", but load_spec() parses JSON specs. Please adjust the help text to say JSON (consistent with init producing nboot-spec.json).
| "--spec", | ||
| required=True, | ||
| type=click.Path(exists=True, path_type=Path), | ||
| help="Path to the project spec YAML file", |
There was a problem hiding this comment.
The new --spec help text refers to a YAML spec file, but this command uses load_spec() which loads JSON. Update the help string to reference JSON (or otherwise align it with supported formats).
| help="Path to the project spec YAML file", | |
| help="Path to the project spec JSON file", |
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
| @@ -53,8 +53,9 @@ def cli() -> None: | |||
| "--spec", | |||
There was a problem hiding this comment.
🔵 LOW: Consistent and Complete CLI Help Texts Added
Confidence: 95%
Help text has now been added to all key CLI options, improving usability and self-documentation for users. This change also helps ensure argument meaning is visible via --help, aligning with best practices for CLI tool UX.
Suggestion: No action required unless further detail is desired for edge case options. Consider reviewing all remaining options to ensure similar clarity.
— Observable code is debuggable code. Consistency helps everyone (even me).
✅ Grippy Review — PASSScore: 98/100 | Findings: 1 Delta: 1 new Commit: beec1a4 |
project-navi-bot
left a comment
project-navi-bot
left a comment
There was a problem hiding this comment.
All required CI checks passed. Auto-approved by navi-bot.
project-navi-bot
left a comment
project-navi-bot
left a comment
There was a problem hiding this comment.
All required CI checks passed. Auto-approved by navi-bot.
|
Thanks for carrying this over with attribution — appreciated. I saw the CI churn note on #35, so no worries on the handoff. I’ll watch for any substantive feedback here and adjust if needed. |
Add help text to CLI options missing descriptions in validate, render,
apply, and diff commands.
Closes #30
Recreated from #35 by Jianjun Wang (@passionworkeer) — original was reverted during CI infrastructure work. See comment below for context.
Co-Authored-By: passionworkeer passionworkeer@users.noreply.github.com