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

Use numpydoc validation as a linter for the documentation #1338

Open

glemaitre opened this issue Feb 17, 2025 · 0 comments

Assignees

Labels

chore documentation

Member

glemaitre commented Feb 17, 2025

To have the most consistent documentation when it comes to the API, we could use the NumPyDoc validator: https://numpydoc.readthedocs.io/en/latest/validation.html

We have such implementation in scikit-learn. It catches discrepancy at the moment where we introduce new documentation.

MarieSacksick added documentation chore labels

auguste-probabl mentioned this issue

ci: Add numpydoc pre-commit hook #1371

Closed

MarieSacksick assigned auguste-probabl

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