← Back to issue list

doc: Unexpected None values in CLI description

View original Github issue

Metadata

Project
charmcraft
Number
#2112
Type
issue
State
open
Author
alex-ramanau
Labels
Created
Updated
Closed

Current evaluation

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.

Suggested action: close stale

Reason: The issue specifically references charmcraft 3.2.0, which is several major versions behind the current 4.4. The current CloseCommand.fill_parser in store.py (lines 1036-1037) provides explicit help strings for both the name and channel arguments, so regenerating the docs would not produce <None> values. No maintainer has engaged in 584 days.

Impact: 15 Quick Win: 12.75 Staleness: 85 Complexity: 15 Confidence: 60 Support Request: 10

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. ![Image](https://github.com/user-attachments/assets/e498923e-1c22-4ca0-8e29-ecb925b8334c) --- Document: reference/commands/close.rst

Evaluation history

Date Model Scores Action Summary
qwen/qwen3.8-27b
Impact: 15
Quick Win: 12.75
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.
qwen3.6-35b-a3b-mtp-q6
Staleness: 95
Complexity: 20
Confidence: 75
Support Request: 5
close stale CLI documentation for the close command incorrectly displays <None> in parameter descriptions and usage. The report remains open, unassigned, and inactive for over a year, awaiting triage and a documentation fix.

Update history

No update history recorded yet.

Related issues

No related issues found above the similarity threshold.