Skip to content

Turn this into a command line tool #2

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

Open
jorgepiloto opened this issue May 4, 2022 · 1 comment
Open

Turn this into a command line tool #2

jorgepiloto opened this issue May 4, 2022 · 1 comment

Comments

@jorgepiloto
Copy link

🐞 Problem

This library solved the issue of runnig numpydoc validation checks outside of the Sphinx documentation build process. Although very useful this library can only be accessed via Python scripts.

💡 Enhancement

It would be interesting to add CLI support. Doing so would allow this tool to be included in different code-style workflows. For example, it could be added to .pre-commit-config.yaml files.

On top of that, being able to declare numpydoc-validation configuration in the pyproject.toml file would be really cool.

@mouseml
Copy link

mouseml commented Aug 28, 2023

Hi, @jorgepiloto! We faced the same problem and had to implement solution on our own. If your problem is still relevant, please, check out Numpydoclint. It's a command line tool for Numpy style docstring validation that can be configured with pyproject.toml file, in-file comments, and more.

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

No branches or pull requests

2 participants