docs: The usage parameters show up as None
Metadata
Current evaluation
charmcraft release docs show usage parameters as <None> <None> <None> instead of channel, name, revision; triaged with Jira ticket CHARMCRAFT-686, no fix yet
Suggested action: keep open
Reason: The issue is a valid documentation bug (auto-generated usage line renders <None> placeholders) and has been triaged (Status: Triaged, Type: Documentation) with an internal ticket CHARMCRAFT-686 created, but no fix or PR is referenced. The current ReleaseCommand in store.py still uses positional/option arguments that could produce such a usage string, so the problem likely persists.
Impact:
20
Quick Win:
15.0
Staleness:
55
Complexity:
25
Confidence:
60
Support Request:
0
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 |
|---|---|---|---|---|
| qwen/qwen3.8-27b |
Impact:
20
Quick Win:
15.0
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. | |
| qwen3.6-35b-a3b-mtp-q6 |
Staleness:
65
Complexity:
20
Confidence:
85
Support Request:
0
|
keep open | charmcraft release command documentation incorrectly shows usage parameters as <None> instead of channel, name, and revision. Status is triaged with an internal ticket created, awaiting documentation fix. |
Update history
No update history recorded yet.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #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. | |
| #2642 Small bug in `charmcraft release` documentation | charmcraft | open | 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 |