-
-
Notifications
You must be signed in to change notification settings - Fork 18.5k
DOC: improve docstring of function where #17665
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
DOC: improve docstring of function where #17665
Conversation
@@ -5822,20 +5822,24 @@ def _where(self, cond, other=np.nan, inplace=False, axis=None, level=None, | |||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
can you update same for .mask
as well.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
mask and where now use the same docstring (with only parts of it substituted with the correct value). But keep doing this and providing a better explanation will become rather complex I think. Are you OK with just duplicating the docstring and have one for where and mask separately ?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
oh that's right. I don't think duplicating is a good idea. maybe just put an example with mask here as well.
Hello @JennaVergeynst! Thanks for updating the PR. Cheers ! There are no PEP8 issues in this Pull Request. 🍻 Comment last updated on September 25, 2017 at 12:54 Hours UTC |
Codecov Report
@@ Coverage Diff @@
## master #17665 +/- ##
==========================================
- Coverage 91.23% 91.21% -0.02%
==========================================
Files 163 163
Lines 49808 49808
==========================================
- Hits 45442 45433 -9
- Misses 4366 4375 +9
Continue to review full report at Codecov.
|
thanks @JennaVergeynst |
Clarified parameters
cond
andother
.Added example with scalar
other
.