search

canonical / craft-cli

https://canonical-craft-cli.readthedocs-hosted.com/en/latest/
GNU Lesser General Public License v3.0
9 stars 15 forks source link

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

Open lengau opened 5 months ago

lengau commented 5 months ago

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.

lengau commented 4 months ago

The first line of __doc__ could also become help_msg if it's missing.