Added an "overview" attribute to each command, with the long help descriptions.
Metadata
Current evaluation
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.
Suggested action: —
No scores available.
Issue body
Also I stopped doing a runtime check of the command integrity, in favor of a test-time verification.
The program output is not tested as it's handled automatically by argparse (it will be properly verified by our tests when we move to the custom-generated helps, in the short future).
@chipaca: feel free to push a commit over this PR for changes in the texts (that will easier for both of us than a bunch of changes).
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| qwen/qwen3.6-35b-a3b | — | — | 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. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged. Introduces an overview attribute to commands containing long help descriptions. Replaces runtime command integrity checks with test-time verification. Author invited collaborators to commit text updates directly. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged. Adds an overview attribute to each command containing long help descriptions. Replaces runtime command integrity checks with test-time verification. Author facundobatista invited collaborators to push direct text updates. |
Update history
No update history recorded yet.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #154 Improved short help messages. | charmcraft | merged | 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. | |
| #5375 test: fix command tests | snapcraft | merged | Merged after updating test fixtures to resolve failing command unit tests. Approved by two reviewers, passed CI checks, and modified two files with 17 additions and 9 deletions. |