Small bug in `charmcraft release` documentation
Metadata
Current evaluation
CLI docs generator renders `None` for required positional args lacking an explicit metavar, visible on the `charmcraft release` reference page.
Suggested action: needs triage
Reason: The issue has no labels, assignee, or maintainer comments, so it has not been triaged. The root cause is visible in tools/docs/gen_cli_docs.py: it uses `action.metavar` directly for required args, and `ReleaseCommand.fill_parser` adds `name` without a metavar, producing `<None>` in generated docs. A small fallback to `action.dest` or adding a metavar would fix it.
Evaluated by: mr-cal-bot
Impact:
25
Quick Win:
18
Complexity:
10
Confidence:
82
Actionability:
80
Issue body
### Check existing issues
- [x] I've verified that this request isn't described by any existing issues.
### Request
Parameter names are replaced by `None` in the documentation both for the CLI usage and docs.
See screenshot.
<img width="771" height="399" alt="Image" src="https://github.com/user-attachments/assets/2643e9fc-3232-4563-8b28-8411ad4ba029" />
### Document location
https://documentation.ubuntu.com/charmcraft/4.0.1/reference/commands/release/
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| ~deepseek/deepseek-pro-latest |
Impact:
25
Quick Win:
18
Complexity:
10
Confidence:
82
Actionability:
80
|
needs triage | CLI docs generator renders `None` for required positional args lacking an explicit metavar, visible on the `charmcraft release` reference page. | |
| qwen/qwen3.6-35b-a3b |
Impact:
30
Quick Win:
19
Complexity:
20
Confidence:
85
Actionability:
80
|
needs triage | charmcraft release documentation incorrectly displays parameter names as None in CLI usage and reference pages. Unlabelled and awaiting maintainer review. | |
| qwen/qwen3.8-27b |
Impact:
20
Quick Win:
17
Staleness:
55
Complexity:
15
Confidence:
75
Support Request:
0
|
needs triage | charmcraft release docs show None for parameter names due to gen_cli_docs.py using action.metavar directly (None when unset); bug still present in current code, no maintainer response in 147 days | |
| qwen3.6-35b-a3b-mtp-q6 |
Staleness:
80
Complexity:
15
Confidence:
95
Support Request:
0
|
needs triage | Documentation for charmcraft release CLI shows parameter names as None instead of actual names. Unlabelled, no maintainer response, inactive for 108 days. | |
| qwen3.6-35b-a3b-mtp-q6 |
Staleness:
75
Complexity:
20
Confidence:
85
Support Request:
5
|
needs triage | Documentation for charmcraft release CLI shows parameter names as None instead of actual names. Untriaged, no maintainer response after 95 days. | |
| qwen3.6-35b-a3b-mtp-q6 |
Staleness:
70
Complexity:
10
Confidence:
90
Support Request:
0
|
needs triage | Documentation for charmcraft release CLI displays parameter names as None instead of actual values. Unlabelled, no maintainer response, inactive for 92 days. |
Update history
No update history recorded yet.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #2578 docs: The usage parameters show up as None | charmcraft | open | Generated `charmcraft release` reference documentation renders required arguments as `<None>` because the docs generator uses null argparse metavars; the triaged issue remains unresolved. | |
| #2865 docs: charmcraft release reference is badly formatted | charmcraft | open | Docs bug report: the published `charmcraft release` command reference shows `charmcraft release [options] <None> <None> <None>` in Usage, plus unformatted channel and resource examples. Untriaged, no maintainer response. |