canonical / canonical/craft-cli

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

Open
#253 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
16
Forks
27
Avg merge
1d 22h
Merged PRs (30d)
10

Description

### 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.

Contributor guide

Open the contributing guide

Research direction

Locate the command overview handling and automatic documentation generation described in the issue. Verify how commands without an overview are currently documented; done means their __doc__ text is used and appears in the generated command documentation.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
cli, documentation
Issue type
Feature
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.