DOC: Miscellaneous docstring fixes #2672
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
Contributor
jhlegarreta
commented
Oct 30, 2022
jhlegarreta
commented
- DOC: Fix parameter name in docstring
- DOC: Mark optional parameters as such in docstring
- DOC: Add parameter description to docstring
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## master #2672 +/- ##
==========================================
- Coverage 84.26% 84.25% -0.01%
==========================================
Files 131 131
Lines 18106 18106
Branches 2930 2930
==========================================
- Hits 15257 15256 -1
Misses 2119 2119
- Partials 730 731 +1
|
skoudoro
reviewed
Oct 31, 2022
Fix parameter name in docstring. Take advantage of the commit to fix the same typo in the value (filename) of the parameter.
Mark optional parameters as such in docstring.
Add parameter description to docstring.
jhlegarreta
force-pushed
the
MiscDocstringFixes
branch
from
5e1b4f2
to
c3c00ee
Compare
skoudoro
approved these changes
Oct 31, 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.