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

Improve doc strings and add type annotations #32

Open
Bronzila opened this issue Jun 26, 2023 · 2 comments · Fixed by #44
Open

Improve doc strings and add type annotations #32

Bronzila opened this issue Jun 26, 2023 · 2 comments · Fixed by #44
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@Bronzila
Copy link
Collaborator

Improve docstrings of DEHB to fit the Google Style Guide for python comments. When adjusting the doc strings it would make sense to adjust the signatures to add type annotations. These changes would improve the general readability of the code.

@Bronzila Bronzila added documentation Improvements or additions to documentation good first issue Good for newcomers labels Jun 26, 2023
@Neeratyoy
Copy link
Collaborator

Can we link this issue to the docs or stylecheck related issues/PRs?

@eddiebergman
Copy link
Contributor

A note on mkdocstrings[python] and using google-style. As long as your function arguments use types, then I've opted to not put them in the docstrings. It makes the docstrings more concise and less likely there's a mismatch. mkdocstring will automatically pull the type definitions from the declaration.

Also ruff has linter checks for missing or extra parameters :) However this check only triggers if there's an Args: entry in the docstring.

@Bronzila Bronzila linked a pull request Jul 24, 2023 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants