Standard docstrings style for the codebase

[pedro-psb]

Problem

Some parts of the codebase use Sphinx-style docstrings and others use Google's, and there is not a clear definition about this. Also, with the addition of auto-generated docs (#1058) , the docs render doesn't come out very pretty.

See here examples of these (and other) different styles.

Proposal

• Define Google Style as the default style
• Change all docstrings to the new format
• Use some linter/formatter to enforce this with out pre-commit setup. (e.g. https://pypi.org/project/docformatter/)

Alternatives

We could use another style as well (if there is a strong opinion towards that). I would only argue that using a linter/auto-formatter should help get the codebase sharp.

[mitches-got-glitches]

Hey @pedro-psb , I wanted to get your thoughts on using ruff for docstring standardisation instead of docformatter? ruff could be brought in for this use case, but eventually it could be swapped in as a replacement for flake8, black and import sorter too.

[rochacbruno]

+1 for google style

[pedro-psb]

I didn't know ruff did that, I'm ok with giving it a try.
Wdyt @rochacbruno ?