search

pyvista / numpydoc-validation

MIT License
0 stars 1 forks source link

Turn this into a command line tool #2

Open jorgepiloto opened 2 years ago

jorgepiloto commented 2 years ago

🐞 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.

nickuzmenkov commented 1 year ago

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.