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.

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

Add flake8-docstrings plugin to tox CI #13083

Closed
nstarman opened this issue Apr 8, 2022 · 4 comments
Closed

Add flake8-docstrings plugin to tox CI #13083

nstarman opened this issue Apr 8, 2022 · 4 comments

Comments

@nstarman
Copy link
Member

nstarman commented Apr 8, 2022

Description

It can be configured to check NumPy docstring style.

Additional context

See bottom of https://flake8.pycqa.org/en/latest/user/using-hooks.html.
It's a very official plugin.

@pllim
Copy link
Member

pllim commented Apr 8, 2022

Oh dear... I am sure we will get a lot of failures.

@nstarman
Copy link
Member Author

nstarman commented Apr 8, 2022

Just think of the beautiful docs when we're done 🥺

@pllim
Copy link
Member

pllim commented Apr 8, 2022

By the time we are done, it is probably time to autodoc from type annotation or something... 🧓

@nstarman
Copy link
Member Author

@pllim So true.
Anyway, ruff has docstrings stuff now that we should be using instead.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants