Unify docstring style guide with numpydoc
#5370
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
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #5370 +/- ##
=======================================
Coverage 96.40% 96.40%
=======================================
Files 134 134
Lines 22826 22826
=======================================
Hits 22005 22005
Misses 821 821 |
|
@pyvista-bot LGTM |
pyvista-bot
approved these changes
Dec 25, 2023
tkoyama010
deleted the
maint/5198-clarify-docstring-length-in-contributingrst
branch
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
resolve #5198
Currently we are using the numpydoc linter and dropping the PEP8 docstring style guide in this PR.
Details