Skip to content
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

Merged
merged 7 commits into from
Feb 10, 2022
Merged

Improve comparison language #2177

merged 7 commits into from
Feb 10, 2022

Conversation

banesullivan
Copy link
Member

@banesullivan banesullivan commented Feb 9, 2022

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:

  • "VTK for humans" -> "Pythonic VTK": while the phrasing was originally contributed by a member of our community, inline with many other tools providing a simplified API to a powerful library (e.g., requests's wrapping of 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.
  • I also noticed a few places where the documentation provides a comparison of PyVista and VTK that portrays VTK in a negative light. While the intent was good (to demonstrate the API that the PyVista community has come to love), it is not fair or respectful to shed a negative light on VTK. The use cases for PyVista and VTK Python are different; both have their advantages and drawbacks and we should be sure to honor that.

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

@github-actions github-actions bot added the documentation Anything related to the documentation/website label Feb 9, 2022
@codecov
Copy link

codecov bot commented Feb 9, 2022

Codecov Report

Merging #2177 (bb2d2b3) into main (67a1336) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main    #2177   +/-   ##
=======================================
  Coverage   93.29%   93.29%           
=======================================
  Files          75       75           
  Lines       15562    15562           
=======================================
  Hits        14519    14519           
  Misses       1043     1043           

Copy link
Member

@tkoyama010 tkoyama010 left a 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.

CODE_OF_CONDUCT.md Outdated Show resolved Hide resolved
Copy link
Member

@akaszynski akaszynski left a 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.

@banesullivan banesullivan merged commit 9957f16 into main Feb 10, 2022
@banesullivan banesullivan deleted the doc/language branch February 10, 2022 00:46
adeak added a commit to basnijholt/pyvista that referenced this pull request Feb 14, 2022
…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)
@akaszynski akaszynski mentioned this pull request Mar 10, 2022
8 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Anything related to the documentation/website
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants