search

automl / DEHB

https://automl.github.io/DEHB/
Apache License 2.0
71 stars 16 forks source link

Improve doc strings and add type annotations #32

Open Bronzila opened 1 year ago

Bronzila commented 1 year ago

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.

Neeratyoy commented 1 year ago

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

eddiebergman commented 1 year ago

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.