Include MultipleLines in documentation #2683
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
github-actions
bot
added
documentation
![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! ⭐
Codecov Report
@@ Coverage Diff @@
## main #2683 +/- ##
=======================================
Coverage 93.70% 93.70%
=======================================
Files 75 75
Lines 16178 16178
=======================================
Hits 15160 15160
Misses 1018 1018 |
MultipleLines was introduced in pyvista#2304 but not included in the documentation. Fix numpydoc warning "RT03: Return value has no description" by adding a description.
|
The error
seems unrelated to this PR. |
MatthewFlamm
approved these changes
May 23, 2022
|
@MatthewFlamm I just added it because numpydoc complained about "RT03: Return value has no description". So it has no other benefit than just to silence the warning. |
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
MultipleLines was introduced in #2304 but not included in the documentation.
Fix numpydoc warning "RT03: Return value has no description" by adding a description.
Resolves #2679.