Clean up numpydoc validation regexen #2525
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
* upstream/main: Make VTK version error clear when PointSet is still abstract (pyvista#2483) Use imageio intersphinx links (pyvista#2489) Fix glyphs when orienting with cell data (pyvista#2500) Bump mypy from 0.942 to 0.950 (pyvista#2522) Update hypothesis requirement from <6.45.1 to <6.45.2 (pyvista#2523) Add many Readers (pyvista#2496) Bump trimesh from 3.10.8 to 3.11.2 (pyvista#2519) Return actor from add_mesh_threshold (pyvista#2516) fix uniformgrid.x docstring (pyvista#2511) Update imageio requirement from <2.18.0 to <2.19.0 (pyvista#2506) Update hypothesis requirement from <6.44.1 to <6.45.1 (pyvista#2507) add polyhedral example (pyvista#2505)
adeak
added
documentation
Codecov Report
@@ Coverage Diff @@
## main #2525 +/- ##
=======================================
Coverage 93.72% 93.72%
=======================================
Files 75 75
Lines 16120 16120
=======================================
Hits 15108 15108
Misses 1012 1012 |
akaszynski
approved these changes
May 5, 2022
adeak
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
While I was trying to figure out for #2483 how to disable validation errors triggered by
PointSet.__new__and__init__I found several issues in the numpydoc validation exemption regex set. I tried to clean these up. Some logical reordering might still be necessary.In the current state of the PR every excluded name is an exact match with the exception of
.*Reader, because there are many of those and many (all?) of them would need to be excluded. Hopefully we won't end up creating a class calledSomethingReaderthat is a different kind of class that would work with numpydoc validation.