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.

Sign up for GitHub

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

Jump to bottom

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

Open
pekasen opened this issue Jul 29, 2022 · 2 comments
Open

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

pekasen opened this issue Jul 29, 2022 · 2 comments

Comments

@pekasen
Copy link
Member

pekasen commented Jul 29, 2022

No description provided.

@pekasen
Copy link
Member Author

pekasen commented Aug 30, 2022

doc string style should be fixed to google style guide.

@pekasen
Copy link
Member Author

pekasen commented Sep 21, 2022

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]

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

When branches are created from issues, their pull requests are automatically linked.

3-idea-lintconvertadd-docstrings-with-pyment Leibniz-HBI/smormlpy
1 participant
@pekasen