add clip box example to docstring #2547
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
Added an example clip box to the doc string and a reference to the example page
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
🚀 Thanks for opening your first pull request in PyVista! 🚀 Please make sure you read (skim 😉) our Contributing Guide and abide by our Code of Conduct.
A few things to keep in mind:
- Remember to run the tests locally to make debugging issues easier.
- If you need help writing tests, take a look at the existing ones for inspiration. If you do not know where to start, let
@pyvista/developersknow and we will walk you through it. - All new features should be documented. It helps to write the docstrings for your functions/classes before writing the code. This will help you think about your code design and results in better code.
- No matter what, we are really grateful that you put in the effort to open this PR! ⭐
akaszynski
reviewed
May 2, 2022
adeak
added
documentation
MatthewFlamm
reviewed
May 3, 2022
Co-authored-by: MatthewFlamm <39341281+MatthewFlamm@users.noreply.github.com>
akaszynski
reviewed
May 3, 2022
Codecov Report
@@ Coverage Diff @@
## main #2547 +/- ##
=======================================
Coverage 93.69% 93.69%
=======================================
Files 75 75
Lines 16159 16159
=======================================
Hits 15140 15140
Misses 1019 1019 |
|
Turns out our box widget isn't being collected. I'm working on a fix. |
|
Merge with main once #2569 is merged. |
MatthewFlamm
reviewed
May 5, 2022
|
This should now run correctly with #2569. Calling this good to merge. |
akaszynski
previously approved these changes
May 6, 2022
akaszynski
approved these changes
May 10, 2022
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.
Overview
Added an example clip box to the doc string and a reference to the box clip example page