-
-
Notifications
You must be signed in to change notification settings - Fork 160
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
Validation rule GL09 failing #573
Comments
stefanv
added a commit
to stefanv/numpydoc
that referenced
this issue
Jul 17, 2024
Thanks for reporting - this seems like a bug in the validator. I agree that |
Thanks for such a fast response ! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
I can't work out how to satisfy GL09 when including a deprecation notice.
Demonstration
For example:
file "sample_code.py"
produces ...
Expected
I think the form in "my_func_right" ought to pass OK.
Workaround
For now, in the Iris project, we are putting all our "deprecated" sections within a "Notes" section,
and have been since we since we adopted numpydoc-validation in pre-commit.
For example here
But this feels like a kluge.
The text was updated successfully, but these errors were encountered: