docs: The usage parameters show up as None
Metadata
Current evaluation
Generated `charmcraft release` reference documentation renders required arguments as `<None>` because the docs generator uses null argparse metavars; the triaged issue remains unresolved.
Suggested action: keep open
Reason: The report is a valid documentation defect, and the generator explicitly emits `action.metavar` for every required action, producing `<None>` when metavars are unset. The issue is labeled Status: Triaged and Type: Documentation, but no resolving commit or merged fix is evidenced; the defect is localized and can be addressed with a metavar fallback plus regression coverage.
Evaluated by: mr-cal-bot
Impact:
38
Quick Win:
27
Complexity:
22
Confidence:
94
Actionability:
90
Issue body
```
Usage
charmcraft release [options] <None> <None> <None>
```
The usage parameters are currently showing up as `<None>`. I believe these are meant to be channel, name and revision in order.
---
*Reported from: https://documentation.ubuntu.com/charmcraft/latest/reference/commands/release/
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| stealth/space-bunny-alpha |
Impact:
38
Quick Win:
27
Complexity:
22
Confidence:
94
Actionability:
90
|
keep open | Generated `charmcraft release` reference documentation renders required arguments as `<None>` because the docs generator uses null argparse metavars; the triaged issue remains unresolved. | |
| stealth/space-bunny-alpha |
Impact:
25
Quick Win:
20
Complexity:
15
Confidence:
96
Actionability:
92
|
keep open | The generated `charmcraft release` reference shows three `<None>` placeholders because the generator inserts required arguments' null metavars; the documentation bug remains open. | |
| qwen/qwen3.6-35b-a3b |
Impact:
30
Quick Win:
22
Complexity:
10
Confidence:
85
Actionability:
80
|
keep open | The `charmcraft release` command usage line shows `<None>` placeholders instead of proper argument names due to missing metavar values in the argument parser configuration. | |
| qwen/qwen3.8-27b |
Impact:
20
Quick Win:
15
Staleness:
55
Complexity:
25
Confidence:
60
Support Request:
0
|
keep 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 | |
| qwen3.6-35b-a3b-mtp-q6 |
Staleness:
55
Complexity:
15
Confidence:
85
Support Request:
0
|
keep open | CLI help text displays <None> placeholders instead of expected parameter names like channel, name, and revision. Issue is triaged and awaiting a fix. | |
| qwen3.6-35b-a3b-mtp-q6 |
Staleness:
55
Complexity:
20
Confidence:
85
Support Request:
0
|
keep open | Documentation bug where charmcraft release CLI usage displays None placeholders instead of expected parameters like channel, name, and revision. Currently triaged and awaiting a fix. | |
| qwen3.6-35b-a3b-mtp-q6 |
Staleness:
65
Complexity:
15
Confidence:
90
Support Request:
0
|
keep open | Documentation bug where CLI usage string displays <None> placeholders instead of expected parameters like channel, name, and revision. Currently triaged and awaiting fix. |
Update history
No update history recorded yet.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #2642 Small bug in `charmcraft release` documentation | charmcraft | open | CLI docs generator renders `None` for required positional args lacking an explicit metavar, visible on the `charmcraft release` reference page. | |
| #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. |