Small bug in `charmcraft release` documentation
Metadata
Current evaluation
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
Suggested action: needs triage
Reason: No labels, no maintainer comments, no assignee in 147 days. The bug is confirmed still present: gen_cli_docs.py line uses action.metavar directly which is None when not explicitly set, and ReleaseCommand.fill_parser does not set metavar on any argument. Trivial fix (use action.metavar or action.dest.upper()) but untriaged.
Impact:
20
Quick Win:
17.0
Staleness:
55
Complexity:
15
Confidence:
75
Support Request:
0
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 |
|---|---|---|---|---|
| qwen/qwen3.8-27b |
Impact:
20
Quick Win:
17.0
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. | |
| qwen3.6-35b-a3b-mtp-q6 |
Staleness:
40
Complexity:
10
Confidence:
90
Support Request:
10
|
needs triage | charmcraft release documentation incorrectly shows parameter names as None in CLI help and web docs. The report remains open, unassigned, and inactive for over two months, awaiting triage and a fix. |
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 | charmcraft release docs show usage parameters as <None> <None> <None> instead of channel, name, revision; triaged with Jira ticket CHARMCRAFT-686, no fix yet | |
| #2865 docs: charmcraft release reference is badly formatted | charmcraft | open | Documentation for `charmcraft release` command has formatting issues: `<None>` placeholders in usage, unformatted channel examples, and broken resource example formatting. |