Clarify clip filter docstring #840
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
akaszynski
reviewed
Jul 17, 2020
akaszynski
reviewed
Jul 17, 2020
akaszynski
reviewed
Jul 17, 2020
akaszynski
approved these changes
Jul 17, 2020
Co-authored-by: Alex Kaszynski <akascap@gmail.com>
Co-authored-by: Alex Kaszynski <akascap@gmail.com>
Co-authored-by: Alex Kaszynski <akascap@gmail.com>
|
Thanks for clarifying what is intended. |
banesullivan
added
the
documentation
Merged
adeak
added a commit
to adeak/pyvista
that referenced
this pull request
Nov 9, 2020
* upstream/master: (37 commits) 🔧 Fix unused variables (pyvista#847) Add better Unstructured Grid Documentation (pyvista#845) Fix typo in plotting.py (pyvista#846) Feat: Implement compute_derivative (pyvista#837) New probe filter and massively improve interpolate filter (pyvista#842) Clarify clip filter docstring (pyvista#840) Update create-structured-surface.py (pyvista#844) Update topo-map.py (pyvista#841) Add release suffix to version string (pyvista#817) Add pathlib Support (pyvista#836) Add tolerance argument to sample_over_line (pyvista#828) vector slice from pyvista/pyvista-support#134 (pyvista#808) Fix is_all_triangles (pyvista#832) Misc. documentation fixes (pyvista#829) Follow up pyvista#793: fix get_data_range (pyvista#818) Fix GPU info in scooby report (pyvista#825) Patch for auto_close warning (pyvista#798) Add texture demo with scalar data (pyvista#821) MAINT: Log init start/stop (pyvista#819) Add PolyData strip filter (pyvista#807) ...
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.
Overview
The clip filter docstring currently states that "If no parameters are given the clip will occur in the center of that dataset." However it isn't really clear why this is true from the defaults of the other parameters. What if I specify just the value? Adding this to the description of origin clarifies this.
The description of value seems to be held over from somewhere else, which is also fixed.
Additionally, I made an edit for consistency (within clip anyway) to end with a period, but I see both styles in other docstrings in this module.
Details
I didn't make any changes, but there is inconsistent usage of
optional. Specifying the default value in the parameter description is also inconsistent throughout the filters. I wasn't sure what is preferred for further cleaning up the clip filter docstring.