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.

Sign up for GitHub

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

Jump to bottom

Add missing Raises description in docstrings according to Google Python style #6164

Open
wusteven815 opened this issue Oct 2, 2024 · 0 comments
Open

Add missing Raises description in docstrings according to Google Python style #6164

wusteven815 opened this issue Oct 2, 2024 · 0 comments
Labels
autocomplete documentation Improvements or additions to documentation python triage

Comments

@wusteven815
Copy link
Contributor

Many of the Python docstrings are missing a description for the raises section, according to the Google style guide. This causes the docstring to not be parsed properly for autocomplete.

For example, they are currently:

Raises:
    DHError

But, it should be:

Raises:
    DHError: Description on why the error was raised
@wusteven815 wusteven815 added documentation Improvements or additions to documentation triage python autocomplete labels Oct 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
autocomplete documentation Improvements or additions to documentation python triage
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@wusteven815