Select docstrings format about srai HOT 6 CLOSED

Docs Issue

from srai.

So far Google format seems the clearest to me, and is compatible with the MKDocs framework

from srai.

Can we somehow enforce any of those formats using black / flake / mypy?
Or maybe set it up as a default format in extensions in vs code / pycharm?

from srai.

I hope there is. Found something like that: https://www.pydocstyle.org/en/stable/, which enforces docstring in the specified format, and then https://pypi.org/project/flake8-docstrings/, so there is A solution

from srai.

also for vscode there is a extension for automatic generation (templates) https://marketplace.visualstudio.com/items?itemName=njpwerner.autodocstring

from srai.

If that's the case then I vote for a Google format since it seems very intuitive for me as well

from srai.