-
-
Notifications
You must be signed in to change notification settings - Fork 167
Incorporate a pre-commit hook for numpydoc validation #450
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
Comments
Sounds useful to me! @rossbar WDYT? |
+1 from me! |
Great! I've initiated the internal review process with our open source program office. I will keep you posted. |
I got the go ahead and have started working on this. I'm hoping to have a PR in next week. |
I ended up not being able to use what I had built before, so I had to write it using a different strategy. I've been testing the basic functionality this week. I added the final piece I was planning as far as functionality today, so I will do more testing this week. The last thing is I have to do is make a test suite, but I'm planning to put in a draft PR this week to get some initial feedback. |
At work, I built a thin wrapper around this repository, so we could run docstring validation checks with pre-commit. If it's of interest, I would like to incorporate a version of this into the numpydoc repository, so others can benefit from docstring validation at commit time.
The text was updated successfully, but these errors were encountered: