Skip to content

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

Merged
merged 3 commits into from
Sep 25, 2017

Conversation

JennaVergeynst
Copy link
Contributor

Clarified parameters cond and other.
Added example with scalar other.

@@ -5822,20 +5822,24 @@ def _where(self, cond, other=np.nan, inplace=False, axis=None, level=None,

Copy link
Contributor

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.

Copy link
Member

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 ?

Copy link
Contributor

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.

@pep8speaks
Copy link

pep8speaks commented Sep 25, 2017

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
Copy link

codecov bot commented Sep 25, 2017

Codecov Report

Merging #17665 into master will decrease coverage by 0.01%.
The diff coverage is 100%.

Impacted file tree graph

@@            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
Flag Coverage Δ
#multiple 89.01% <100%> (ø) ⬆️
#single 40.32% <100%> (-0.07%) ⬇️
Impacted Files Coverage Δ
pandas/core/generic.py 92.07% <100%> (ø) ⬆️
pandas/io/gbq.py 25% <0%> (-58.34%) ⬇️
pandas/core/frame.py 97.73% <0%> (-0.1%) ⬇️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 83c9205...cf8f081. Read the comment docs.

@jreback jreback added this to the 0.21.0 milestone Sep 25, 2017
@jreback jreback merged commit 5279a17 into pandas-dev:master Sep 25, 2017
@jreback
Copy link
Contributor

jreback commented Sep 25, 2017

thanks @JennaVergeynst

alanbato pushed a commit to alanbato/pandas that referenced this pull request Nov 10, 2017
No-Stream pushed a commit to No-Stream/pandas that referenced this pull request Nov 28, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants