docs: charmcraft release reference is badly formatted
Metadata
Current evaluation
Documentation for `charmcraft release` command has formatting issues: `<None>` placeholders in usage, unformatted channel examples, and broken resource example formatting.
Suggested action: needs triage
Reason: The issue reports specific documentation formatting problems (e.g., `<None>` placeholders, missing lists/codeblocks) but has no labels or maintainer comments yet. It requires triage to assign or prioritize the doc fix.
Impact:
10
Quick Win:
9.0
Staleness:
0
Complexity:
10
Confidence:
90
Support Request:
0
Issue body
1. Usage says:
> `charmcraft release [options] <None> <None> <None>`
2. The channel examples should be more clearly formatted as a list.
3. The resource example has linebreaks and some bad formatting going on (e.g. not a codeblock)
---
*Reported from: https://canonical.com/juju/docs/charmcraft/4/reference/commands/release/*
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| qwen3.6-35b-a3b-mtp-q6 |
Impact:
10
Quick Win:
9.0
Staleness:
0
Complexity:
10
Confidence:
90
Support Request:
0
|
needs triage | Documentation for `charmcraft release` command has formatting issues: `<None>` placeholders in usage, unformatted channel examples, and broken resource example formatting. |
Update history
| Date | Change |
|---|---|
| created |
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 | |
| #2859 Documentation links created by charmcraft are invalid | charmcraft | open | Charmcraft CLI help text generates invalid documentation links using full version numbers (e.g., 4.4.1) instead of stable or major version, causing 404 errors. | |
| #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 |