DOC Fixing EX01 - added examples #53181
Conversation
pandas/core/groupby/generic.py
Outdated
| def is_monotonic_increasing(self) -> Series: | ||
| # GH13 |
There was a problem hiding this comment.
Yeah we don't need this (and below)
There was a problem hiding this comment.
Thanks, I'll remove them.
|
I can't tell (for sure) if failing tests are related to my changes |
| >>> s = pd.Series([3, 2, 2, 1]) | ||
| >>> s.is_monotonic_decreasing |
There was a problem hiding this comment.
for this and the above, could we add an example for when the return value is False?
In general, for functions which return -> bool, it's probably good to have a simple example of both cases (something quick and simple is fine)
There was a problem hiding this comment.
Done, thanks for the instructions.
| >>> s.is_unique | ||
| False |
There was a problem hiding this comment.
this one also returns bool ;) rest looks good though!
There was a problem hiding this comment.
I should have seen it :) .. thanks
pandas/core/groupby/generic.py
Outdated
| def is_monotonic_decreasing(self) -> Series: | ||
| """ | ||
| Return boolean if values in the group are monotonically decreasing. |
There was a problem hiding this comment.
so sorry, I missed this the first time round
it doesn't return a boolean, but a Series of booleans
pandas/core/groupby/generic.py
Outdated
| Returns | ||
| ------- | ||
| bool |
pandas/core/groupby/generic.py
Outdated
| Return boolean if values in the group are monotonically increasing. | ||
|
|
||
| Returns | ||
| ------- | ||
| bool |
|
Thanks @MarcoGorelli! - love the cat |
* DOC Fixing EX01 - added examples * Removed Index.item from code_checks * Removed #GH13 * Added case for return value=False * Added False case for is_unique * Correct docstring * really minor clarification (there may be multiple groups, so "the group" isnt defined) --------- Co-authored-by: MarcoGorelli <[email protected]>
* DOC Fixing EX01 - added examples * Removed Index.item from code_checks * Removed #GH13 * Added case for return value=False * Added False case for is_unique * Correct docstring * really minor clarification (there may be multiple groups, so "the group" isnt defined) --------- Co-authored-by: MarcoGorelli <[email protected]>
* DOC Fixing EX01 - added examples * Removed Index.item from code_checks * Removed #GH13 * Added case for return value=False * Added False case for is_unique * Correct docstring * really minor clarification (there may be multiple groups, so "the group" isnt defined) --------- Co-authored-by: MarcoGorelli <[email protected]>
Towards #37875
I couldn't locally build the html files for
Series.SeriesGroupBy.is_monotonic_increasingandSeries.SeriesGroupBy.is_monotonic_decreasing. Followed noatamir/pyladies-berlin-sprints#13 to split the docstrings from Series - but I'm not sure if adding #GH13 to the docstring is correctCouldn't use a variable like {klass} for
item()to avoid hardcodingSeriesorIndex.