DOC: Added example to NDFrame.where #13798
Conversation
| ________ | ||
|
|
||
| >>> df = pd.DataFrame(np.arange(10).reshape(-1, 2), columns=['A', 'B']) | ||
| >>> df.where(df % 3, -df) |
There was a problem hiding this comment.
as cond should be a boolean DataFrame, df % 3 != 0 is better as an example. Also, I prefer arange(1, 11) because -0 = 0 (or whatever example that user can clearly understand).
There was a problem hiding this comment.
Noted and updated!
| ________ | ||
|
|
||
| >>> df = pd.DataFrame(np.arange(10).reshape(-1, 2), columns=['A', 'B']) | ||
| >>> df.where(df % 3 == 0, -df) |
There was a problem hiding this comment.
Changed to boolean DataFrame and flipped bools so as to not induce confusion with 0 -> -0 -> 0.
|
I think adding how this can emulate np.where would also be useful (add in a Note section for that) |
|
from your expl on SO |
Current coverage is 85.28% (diff: 100%)@@ master #13798 diff @@
==========================================
Files 139 139
Lines 50214 50214
Methods 0 0
Messages 0 0
Branches 0 0
==========================================
+ Hits 42822 42823 +1
+ Misses 7392 7391 -1
Partials 0 0
|
| to `np.where(m, df1, df2`. | ||
|
|
||
| Examples | ||
| ________ |
There was a problem hiding this comment.
Can you use dashes (-) instead of underscores (_)?
Thanks for feedback! |
| Notes | ||
| ----- | ||
| The signature for :func:`DataFrame.where` differs from | ||
| :func:`numpy.where`. Roughly ``df1.where(m, df2)`` is equivalent to |
There was a problem hiding this comment.
you don't need the double-backticks here as this is not markdown.
There was a problem hiding this comment.
jeff, it's the other way around :-) (it's markdown that does not need double backticks)
There was a problem hiding this comment.
my bad, @jorisvandenbossche is right!
|
can you update |
|
Yep, will do. On Tue, Aug 9, 2016 at 7:23 PM Jeff Reback [email protected] wrote:
|
|
I noticed that most examples on the method's page use the |
|
@jalexvig no, use the doc-string syntax. These are viewable from the command line, not generated docs (they are generated too, but that's not the primary use) |
|
@jalexvig Thanks a lot! |
No description provided.