Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
lengau opened this issue Apr 22, 2024 · 1 comment
Open

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

lengau opened this issue Apr 22, 2024 · 1 comment

Comments

@lengau
Copy link
Contributor

lengau commented Apr 22, 2024

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 lengau changed the title Use a command class's __doc__ if overview` does not exist Use a command class's __doc__ if overview does not exist Apr 22, 2024
@lengau
Copy link
Contributor Author

lengau commented Jun 6, 2024

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant