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

[Feature] Add validation for numpydoc #56

Open
K-Meech opened this issue Mar 20, 2024 · 0 comments
Open

[Feature] Add validation for numpydoc #56

K-Meech opened this issue Mar 20, 2024 · 0 comments
Labels
enhancement New feature or request

Comments

@K-Meech
Copy link
Contributor

K-Meech commented Mar 20, 2024

Is your feature request related to a problem? Please describe.
Currently, there are no checks for docstring style, meaning it is easy to introduce styles like reST erroneously.

Describe the solution you'd like
We could add validation of numpydoc via precommit with a pre-commit hook. Individual rules can be easily ignored in the pyproject.toml like so

[tool.numpydoc_validation]
checks = [
    "all",   # report on all checks, except the below
    "EX01",
    "SA01",
    "ES01",
]
@K-Meech K-Meech added the enhancement New feature or request label Mar 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant