-
Notifications
You must be signed in to change notification settings - Fork 440
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
Link to pytest-pyvista in docs #4153
Conversation
Codecov Report
@@ Coverage Diff @@
## main #4153 +/- ##
=======================================
Coverage 95.57% 95.57%
=======================================
Files 95 95
Lines 20250 20250
=======================================
Hits 19353 19353
Misses 897 897 |
@@ -0,0 +1,6 @@ | |||
.. _ref_pytest_plugin_docs: | |||
|
|||
PyVista Pytest Plugin |
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.
Super nitpicky/bikesheddy, but I wonder about the casing of "Pytest". Looking at https://docs.pytest.org it seems to me that the project styles itself as "pytest":
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.
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.
We're using "title case", so I updated it in the body, but didn't update the title.
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.
We could add an exception just like we do for PyVista and others. I don't insist though.
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.
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.
So should we switch or keep titlecase?
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.
I'm on the fence about this as well. Looking at their docs, they consistently do not capitalize it, even when it starts their sentence case titles:
https://docs.pytest.org/en/7.2.x/contents.html
Honestly, I think it looks weird if it's the only word not capitalized in our section titles. I think an exception would be gRPC, where GRPC (all caps) or Grpc would look strange. In this case, I think we're fine with "as-is" since it doesn't "look weird."
Co-authored-by: Andras Deak <adeak@users.noreply.github.com>
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.
Calling this good to go.
Overview
Add some links to pytest-pyvista documentation.