docs: charmcraft release reference is badly formatted
Metadata
Current evaluation
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.
Suggested action: needs triage
Reason: The issue is untriaged: 'Labels: none', 'Comment count: 0', and no maintainer acknowledgement31 days after an external contributor (marcusboden) filed it. The report is concrete — three enumerated defects (literal `<None> <None> <None>` usage placeholders, channel examples needing list formatting, resource example with stray line breaks outside a code block) plus the source URL — so it is reproducible by inspecting the generated reference page, but I could not confirm the current state because repo file/commit inspection was unavailable ('No pinned SHA available for project charmcraft'), so it may partly be fixed or may depend on upstream craft-application help rendering.
Evaluated by: mr-cal-bot
Issue body
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| stealth/space-bunny-alpha |
Impact:
25
Quick Win:
9
Complexity:
45
Confidence:
58
Actionability:
68
|
needs triage | 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. | |
| stealth/space-bunny-alpha |
Impact:
27
Quick Win:
19
Complexity:
18
Confidence:
91
Actionability:
88
|
needs triage | The open, untriaged release reference shows <None> usage placeholders and poorly formatted channel and resource examples. | |
| qwen3.6-35b-a3b-mtp-q6 |
Impact:
10
Quick Win:
9
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 work
-
Related To:
charmcraft#2299
(confidence 40%)
Merged PR titled 'docs: fix formatting issues' (2 files, +3/-1) is a prior docs-formatting cleanup, but its small diff suggests it targeted docs build errors rather than generated command-reference rendering; unverified overlap.
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. | |
| #1435 `charmcraft release` doesn't use output text from the store. | charmcraft | open | charmcraft release ignores Charmhub's response and prints resource details from CLI arguments, potentially reporting a different revision than was attached; no fix or maintainer response is recorded. | |
| #1851 How-to doc for charmcraft test | charmcraft | open | Documentation request from a maintainer to write a how-to guide for the undocumented `charmcraft test` command. Open with no labels, assignee, or maintainer triage; only an automated Jira-sync bot comment (CRAFT-3957). | |
| #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. | |
| #2589 docs: add Charmcraft 4.2 release notes | charmcraft | merged | Merged: release notes for Charmcraft 4.2 (dated 17 March 2026) added via commit ec9e0727 (+113 lines across docs/release-notes/charmcraft-4.2.rst and the release-notes index). CI failures were pre-existing/unrelated to the docs change. | |
| #2801 docs: add Charmcraft 4.4 release notes | charmcraft | merged | Merged docs PR adding Charmcraft 4.4 release notes (commit 82e9de8b, 4 files, +188/-4), landing in docs/release-notes/charmcraft-4.4.rst and indexed in docs/release-notes/index.rst. | |
| #1434 Improve Documentation for 'charmcraft help clean' Command | charmcraft | open | Documentation request for `charmcraft clean` help text; current overview is brief and issue lacks specific gaps. Related PR #2795 was rejected as subpar; no maintainer triage on issue. | |
| #2795 docs: improve `charmcraft clean` command documentation | charmcraft | closed | Closed unmerged; maintainer @lengau rejected the proposed charmcraft clean documentation as subpar, and no documentation commit or replacement PR landed. | |
| #2967 docs: Charmcraft 4.5.0 release notes | charmcraft | merged | Merged PR adding Charmcraft 4.5.0 release notes to the documentation. | |
| #2306 docs: release notes for Charmcraft 4.0 | charmcraft | merged | Merged #2306 via commit b04fae05, adding Charmcraft 4.0 release notes across four documentation files. |