-
Notifications
You must be signed in to change notification settings - Fork 441
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
Improve comparison language #2177
Conversation
Codecov Report
@@ Coverage Diff @@
## main #2177 +/- ##
=======================================
Coverage 93.29% 93.29%
=======================================
Files 75 75
Lines 15562 15562
=======================================
Hits 14519 14519
Misses 1043 1043 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@banesullivan Thank you for pointing this out. I've always felt that PyVista should be more respectful of VTK. I have one point comment for this changes.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for adding this.
I have always been amazed at VTK's speed and usability, even without wrapping it with PyVista. The original intent of this library was to increase the adoption of VTK in the Python community by making it seem more "Pythonic", while retaining (most) of the performance of the VTK library, and not to replace it (which would be next to impossible). I agree wholeheartedly that we do indeed "stand on the shoulders of giants."
I'll be on the lookout for additional sections that need tweaking.
…ints_clip_widget * upstream/main: Bump typing-extensions from 4.0.1 to 4.1.1 (pyvista#2216) Update imageio requirement from <2.16.0 to <2.17.0 (pyvista#2215) Add flake8-black to dependencies (pyvista#2213) Fix operater space by black version 22.1.0 (pyvista#2212) Style/black and resolve many flake8 issues (pyvista#2180) Update link to CONTRIBUTING.rst in greetings action (pyvista#2200) Fix Install OS Packages error (pyvista#2196) Fix link syntax error (pyvista#2182) Improve comparison language (pyvista#2177) Feat/add image threshold (pyvista#2174) add merge to utilities (pyvista#2176) Fix broken link to contributing guide in documents (pyvista#2173)
Upon reflection, some of the language used in PyVista's documentation is not inline with the values I believe we should hold.
Specifically, some language in PyVista's documentation comparing PyVista to VTK sheds a negative light on VTK, failing to acknowledge the hard work of those who developed VTK and the value VTK has proven to hold in its 20+ year history.
I believe it is of the utmost importance to consider the fact that PyVista stands on shoulders of giants, namely VTK and NumPy, and that we should acknowledge that fact while being respectful to the broader communities behind those software.
This pull request specifically changes a few concerning language choices:
urllib3
and "HTTP for Humans™" tagline), and capturing the beauty of PyVista's simplified API, it demonstrates a lack of respect for the humans who created VTK and their hard work building the backbone of PyVista.Additionally, I added some notes to our Code of Conduct to encourage the use of respectful language moving forward.
I suspect I most likely did not capture all occurrences of non-flattering language and would like to ask @pyvista/developers to please follow up in other Pull Requests to improve our language across the documentation