doc: Unexpected None values in CLI description
Metadata
Current evaluation
Generated CLI reference docs show `<None>` for positional args (e.g. `close`'s `name` and `channel`) because the doc generator uses `action.metavar`, which is unset for those args. Unlabelled and untriaged.
Suggested action: needs triage
Reason: The issue has no labels, comments, or maintainer response, so it has not been assessed. The reproducer is clear (published docs URL and screenshot), and code inspection shows `CloseCommand.fill_parser` adds positional args without metavar while `tools/docs/gen_cli_docs.py` renders `action.metavar` directly, producing `<None>`.
Evaluated by: mr-cal-bot
Impact:
30
Quick Win:
17
Complexity:
20
Confidence:
75
Actionability:
70
Issue body
Please have a look at https://canonical-charmcraft.readthedocs-hosted.com/en/3.2.0/reference/commands/close/# . It contains "\<None\>" values in the params description and Usage.
---
Document: reference/commands/close.rst
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| ~deepseek/deepseek-pro-latest |
Impact:
30
Quick Win:
17
Complexity:
20
Confidence:
75
Actionability:
70
|
needs triage | Generated CLI reference docs show `<None>` for positional args (e.g. `close`'s `name` and `channel`) because the doc generator uses `action.metavar`, which is unset for those args. Unlabelled and untriaged. | |
| qwen/qwen3.6-35b-a3b |
Impact:
30
Quick Win:
22
Complexity:
10
Confidence:
80
Actionability:
80
|
keep open | Documentation generation script produces '<None>' in CLI reference for the 'close' command due to unhandled None metavar values in gen_cli_docs.py | |
| qwen/qwen3.8-27b |
Impact:
15
Quick Win:
13
Staleness:
85
Complexity:
15
Confidence:
60
Support Request:
10
|
close stale | Auto-generated CLI docs for the close command in charmcraft 3.2.0 show <None> values in parameter descriptions and Usage. No maintainer response in 584 days; current code has proper help strings. | |
| qwen/qwen3.6-35b-a3b |
Staleness:
92
Complexity:
15
Confidence:
85
Support Request:
5
|
needs triage | Documentation for the close CLI command displays <None> in parameter descriptions and usage. Unaddressed for over 1.5 years with no maintainer interaction or labels. | |
| qwen3.6-35b-a3b-mtp-q6 |
Staleness:
90
Complexity:
10
Confidence:
85
Support Request:
5
|
needs triage | Documentation for the close CLI command displays literal <None> values in parameter descriptions and usage examples. The issue is unlabelled, has zero maintainer interaction, and has been inactive for over 14 months. | |
| qwen3.6-35b-a3b-mtp-q6 |
Staleness:
95
Complexity:
20
Confidence:
85
Support Request:
10
|
close stale | Documentation for the close CLI command displays <None> placeholders in parameter descriptions and usage output. Unaddressed for over a year with no maintainer interaction. |
Update history
No update history recorded yet.
Related issues
No related issues found above the similarity threshold.