feat: add documentation link in help messages
Metadata
Current evaluation
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.
Suggested action: —
No scores available.
Issue body
- [x] Have you followed the guidelines for contributing?
- [x] Have you signed the [CLA](http://www.ubuntu.com/legal/contributors/)?
- [x] Have you successfully run `tox`?
Adds a documentation link to the bottom of general help and a command-specific link to command help messages.
I did not add a URL link to the markdown format of command help.
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| qwen/qwen3.6-35b-a3b | — | — | 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. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged by mr-cal, adding documentation links to general and command-specific help messages. Markdown format command help was intentionally excluded. |
Update history
No update history recorded yet.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #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. | |
| #111 Added the option of showing the help for a command in markdown format (CRAFT-1207). | craft-cli | merged | Merged. Added markdown format support for command help output (CRAFT-1207). Approved by one reviewer with zero unresolved comments. Changes span three files with 452 additions and 68 deletions. | |
| #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. | |
| #306 feat: remove code backticks in CLI help messages | craft-cli | merged | Merged following approval by two reviewers and successful CI checks. The update removes code backticks from CLI help messages, closes #303. Changes affect two files with 90 additions and zero deletions. | |
| #271 feat: display positional args in help | craft-cli | merged | Merged to display positional arguments in help output. Approved by two reviewers, passed checks, and modified three files with 38 additions and 3 deletions. | |
| #102 feat: compress documentation files | debcraft | merged | Merged a helper to compress man pages, info files, and other documentation files with hard and symbolic link handling. Approved by two reviewers and passed CI checks, adding 455 lines across four files. | |
| #288 docs: consolidate external links | rockcraft | merged | Merged documentation update consolidating external links. Approved by two reviewers, passed CI checks, and modified six files with 19 additions and 12 deletions. | |
| #10 docs: improve README | snapcraft-rocks | merged | Merged documentation update improving the README. Approved by two reviewers, adding 66 lines and removing one across a single file. |