Convert remaining docstrings to numpydoc style #66
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 #66 +/- ##
==========================================
+ Coverage 89.07% 89.15% +0.07%
==========================================
Files 35 35
Lines 1355 1355
==========================================
+ Hits 1207 1208 +1
+ Misses 148 147 -1 ☔ View full report in Codecov by Sentry. |
willGraham01
approved these changes
Apr 9, 2024
| Returns | ||
| ------- | ||
| pd.DataFrame | ||
| Dataframe with Inf replaced with NaN. | ||
| """ | ||
| df = df.replace(np.inf, np.nan) |
There was a problem hiding this comment.
Not sure why we have a whole function that creates a copy, assigns it to the input, then returns the input, but it was here before so I won't question it.
Though it does seem like overkill when
df.replace(np.inf, np.nan, inplace=True)does literally the same thing.
There was a problem hiding this comment.
Yes it does seem like overkill! I guess it is needed elsewhere in BrainGlobe
Co-authored-by: Will Graham <[email protected]>
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.
Description
What is this PR
Why is this PR needed?
Some docstrings are still in reST format.
What does this PR do?
Updates all remaining docstrings to
numpydocformat.References
For #19
How has this PR been tested?
All tests pass locally.
Is this a breaking change?
No
Does this PR require an update to the documentation?
No
Checklist: