← Back to issue list

Use a command class's `__doc__` if `overview` does not exist

View original Github issue

Metadata

Project
craft-cli
Number
#253
Type
issue
State
open
Author
lengau
Labels
Created
Updated
Closed

Current evaluation

Feature request to use a command class's __doc__ as a fallback for the overview attribute when it is not defined, improving automatic documentation. Still unimplemented; overview remains mandatory in BaseCommand.__init__ and no docstring fallback exists in the codebase.

Suggested action: keep open

Reason: The issue is old (861 days, last activity 816 days ago) but the feature is still unimplemented: dispatcher.py still lists overview in the mandatory tuple and no __doc__ fallback logic exists anywhere in the codebase. It is a valid, well-scoped enhancement from a maintainer that would reduce boilerplate for command authors, so it remains relevant rather than obsolete.

Impact: 35 Quick Win: 24.5 Staleness: 75 Complexity: 30 Confidence: 80 Support Request: 0

Issue body

### What needs to get done The `overview` attribute is often duplicative of a command class's docstring. If the `overview` attribute doesn't exist, use the command's docstring instead. ### Why it needs to get done Helps make automatic documentation better, since it'll display the command docs.

Evaluation history

Date Model Scores Action Summary
qwen/qwen3.8-27b
Impact: 35
Quick Win: 24.5
Staleness: 75
Complexity: 30
Confidence: 80
Support Request: 0
keep open Feature request to use a command class's __doc__ as a fallback for the overview attribute when it is not defined, improving automatic documentation. Still unimplemented; overview remains mandatory in BaseCommand.__init__ and no docstring fallback exists in the codebase.
qwen/qwen3.6-35b-a3b
Staleness: 90
Complexity: 20
Confidence: 80
Support Request: 10
close stale Feature request to fallback to command class docstrings for overview and help_msg to improve auto-generated documentation. Currently unlabelled and inactive for over two years.
qwen3.6-35b-a3b-mtp-q6
Staleness: 85
Complexity: 20
Confidence: 75
Support Request: 5
needs triage Feature request to fallback to a command class docstring for the overview attribute when missing, improving auto-generated documentation. Currently unlabelled and inactive for over two years.
qwen3.6-35b-a3b-mtp-q6
Staleness: 85
Complexity: 20
Confidence: 75
Support Request: 0
needs triage Fallback to command class docstring when overview is missing, with maintainer suggesting first line as help_msg. Improves auto-generated documentation. Currently open and awaiting implementation or assignment.

Update history

No update history recorded yet.

Related issues

No related issues found above the similarity threshold.