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

Link to pytest-pyvista in docs #4153

Merged
merged 4 commits into from
Mar 19, 2023
Merged

Conversation

MatthewFlamm
Copy link
Contributor

Overview

Add some links to pytest-pyvista documentation.

@github-actions github-actions bot added documentation Anything related to the documentation/website maintenance Low-impact maintenance activity labels Mar 17, 2023
@codecov
Copy link

codecov bot commented Mar 17, 2023

Codecov Report

Merging #4153 (e4f1831) into main (a693f8d) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main    #4153   +/-   ##
=======================================
  Coverage   95.57%   95.57%           
=======================================
  Files          95       95           
  Lines       20250    20250           
=======================================
  Hits        19353    19353           
  Misses        897      897           

CONTRIBUTING.rst Outdated Show resolved Hide resolved
doc/source/extras/pytest_plugin.rst Outdated Show resolved Hide resolved
@@ -0,0 +1,6 @@
.. _ref_pytest_plugin_docs:

PyVista Pytest Plugin
Copy link
Member

@adeak adeak Mar 17, 2023

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":

screenshot from docs.pytest.org with a bunch of lowercase "pytest"s, even outside a coding context, at the start of a sentence

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Member

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.

Copy link
Member

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.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I most admit I was lazy, but not that lazy, and only googled it and saw this. Their website proper consistently uses lower case. I think we could use either here.

Screenshot_20230317-201842

Copy link
Member

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?

Copy link
Member

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."

akaszynski and others added 2 commits March 17, 2023 17:36
Co-authored-by: Andras Deak <adeak@users.noreply.github.com>
akaszynski
akaszynski previously approved these changes Mar 17, 2023
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.

Calling this good to go.

@akaszynski akaszynski merged commit e9d9ed7 into main Mar 19, 2023
@akaszynski akaszynski deleted the maint/better-linkage-to-pytest-pyvista branch March 19, 2023 03:42
@akaszynski akaszynski mentioned this pull request Apr 30, 2023
6 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 maintenance Low-impact maintenance activity
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants