Add dataset attributes to the docs #2109
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
github-actions
bot
added
documentation
adeak
reviewed
Jan 30, 2022
| CODESPELL_SKIP ?= "*.pyc,*.txt,*.gif,*.png,*.jpg,*.ply,*.vtk,*.vti,*.vtu,*.js,*.html,*.doctree,*.ttf,*.woff,*.woff2,*.eot,*.mp4,*.inv,*.pickle,*.ipynb,flycheck*,./.git/*,./.hypothesis/*,*.yml,./doc/_build/_static/*,./doc/images/*,./dist/*,*~,.hypothesis*,./doc/examples/*,*.mypy_cache/*,*cover,./tests/tinypages/_build/*,*/_autosummary/*" | ||
| CODESPELL_SKIP ?= "*.pyc,*.txt,*.gif,*.png,*.jpg,*.ply,*.vtk,*.vti,*.vtu,*.js,*.html,*.doctree,*.ttf,*.woff,*.woff2,*.eot,*.mp4,*.inv,*.pickle,*.ipynb,flycheck*,./.git/*,./.hypothesis/*,*.yml,doc/_build/*,./doc/images/*,./dist/*,*~,.hypothesis*,./doc/examples/*,*.mypy_cache/*,*cover,./tests/tinypages/_build/*,*/_autosummary/*" |
There was a problem hiding this comment.
See ongoing discussion in #2108 (comment)... It would be better to have clear justification for these changes. And now we have a mixture of ./doc/.. and doc/... in there, which would again be nicer to unify.
Comment on lines
+13
to
+16
| * Topology defines the structure of the dataset, or how the points are connected | ||
| to each other to form a cells making a surface or volume. | ||
| * Attributes are any data values that are associated to either the points or | ||
| cells of the dataset |
There was a problem hiding this comment.
There's "to form a cells making" typo, and a missing trailing period.
| @@ -69,6 +69,15 @@ class DataSetAttributes(_vtk.VTKObjectWrapper): | |||
| association : FieldAssociation | |||
| The array association type of the vtkobject. | |||
|
|
|||
| Notes | |||
| ----- | |||
| When printing out the point arrays, you can see which arrays are | |||
| rotated along with the geometry when the DataSet is passed | ||
| through a transformation filter. | ||
|
|
||
| When adding non-directional data (such temperature values or |
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.
As pointed out in #2097 (reply in thread) by @MatthewFlamm, we're missing documentation for
pyvista.DataSetAttributes.This PR add the documentation and fixes the class and method docstrings due to the various numpydoc validation warnings.