Improved short help messages.
Metadata
Current evaluation
Merged improvements to short help messages for commands and parameters, updating output per UX suggestions. Approved by two reviewers, passed CI, and modified eight files as part of a broader help overhaul.
Suggested action: —
No scores available.
Issue body
This includes the command ones and command's parameters ones.
Also fixed some output messages as per UX dept. suggestion.
This is part of the [big adjust help process](https://github.com/canonical/charmcraft/pull/153).
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| qwen/qwen3.6-35b-a3b | — | — | Merged improvements to short help messages for commands and parameters, updating output per UX suggestions. Approved by two reviewers, passed CI, and modified eight files as part of a broader help overhaul. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged updates to short help messages for commands and parameters, plus output message fixes per UX guidelines. Part of a broader help system overhaul. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged improvements to short help messages for commands and parameters, plus output message fixes per UX suggestions. Part of a broader help system adjustment. |
Update history
No update history recorded yet.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #171 Improvements per ux review | charmcraft | merged | Merged after two reviewer approvals and passing CI. Updates help text formatting across five files, center-aligning columns and applying several small UX improvements to command-line output. | |
| #153 Adjust help messages in all cases to UX indications | charmcraft | merged | Merged changes adding a dedicated help command, disabling automatic ArgumentParser help handling, and improving usage and error messages. Tests moved to test_help.py. Approved by two reviewers with 382 additions and 175 deletions across three files. | |
| #163 Two small details before integrating help messages to main. | charmcraft | merged | Merged after two approvals. Added an argsparsing option to CommandError for immediate help display and a helper to check command arguments. Modified four files with minor adjustments to prepare for a larger message refactoring. | |
| #777 Use helpful messages | rockcraft | merged | Merged yanksyoon's update that replaces unhelpful experimental feature messages with clearer guidance and fixes a broken documentation link. Approved by two reviewers, passed CI, and merged with a minimal diff. | |
| #130 Added an "overview" attribute to each command, with the long help descriptions. | charmcraft | merged | Merged after adding an overview attribute to commands with long help text. Runtime integrity checks were replaced with test-time verification. Approved by one reviewer with passing CI, modifying eight files. | |
| #298 feat: add documentation link in help messages | craft-cli | merged | Added documentation links to general and command-specific help messages. Merged after approval by two reviewers, modifying five files (+128/-46 lines). Markdown format help was intentionally excluded. | |
| #557 feat: add documentation link in help messages | craft-application | merged | Merged. Adds documentation links to general and command help messages. Approved by two reviewers, passed CI, and modified six files. Formatting adjustments resolved linter warnings. | |
| #156 Text builders for simple usage, detailed help, and command help. | charmcraft | merged | Merged text builders for simple usage, detailed help, and command help. Approved by two reviewers and integrated as part of a broader help adjustment process. Changes span three files with 362 additions and 6 deletions. | |
| #550 Transformed the help management to be implemented not using a command (CRAFT-542). | charmcraft | merged | Merged refactoring centralizing help management during initial argument pre-parsing instead of a standalone command. Adds ProvideHelpException for better guidance. Approved by two reviewers and merged with 181 additions and 153 deletions across four files. | |
| #1789 cli: improve the help command | snapcraft | merged | Improved the CLI help command to match --help parity and expose hidden topics and plugin help. Merged after reviewer approval and passing CI, modifying three files with 62 additions and 11 deletions. |