search

Leibniz-HBI / smormlpy

A cookiecutter skeleton for SMO/MRML python tools.
MIT License
0 stars 0 forks source link

[Idea] lint/convert/add docstrings with `pyment` #3

Open pekasen opened 2 years ago

pekasen commented 2 years ago

doc string style should be fixed to google style guide.

pekasen commented 2 years ago

Way to check compliance in docstrings seems to be pydocstyle. It even sports a pre-commit integration which is configurable to our needs:

-   repo: https://github.com/PyCQA/pydocstyle
    rev: 6.1.1
    hooks:
    -   id: pydocstyle
        args: [--convention=google]