-
-
Notifications
You must be signed in to change notification settings - Fork 18.5k
DOC: improved the docstring of pandas.Series.clip_upper improved #20135
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
Changes from 2 commits
51f612c
da2dac7
86bc86e
3e53972
c98dcd8
d4cac1b
124d7f0
a77b491
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -5635,24 +5635,68 @@ def clip(self, lower=None, upper=None, axis=None, inplace=False, | |
|
||
def clip_upper(self, threshold, axis=None, inplace=False): | ||
""" | ||
Return copy of input with values above given value(s) truncated. | ||
Return copy of the input with values above given value(s) truncated. | ||
|
||
It truncates values above a certain threshold. Threshold can be a | ||
single value or an array, in the latter case it performs the | ||
truncation | ||
element-wise. | ||
|
||
Parameters | ||
---------- | ||
threshold : float or array_like | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I think we use array-like (with hyphen) |
||
Maximum value allowed. All values above threshold will be | ||
set to this value. | ||
axis : int or string axis name, optional | ||
Align object with threshold along the given axis. | ||
inplace : boolean, default False | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. we use |
||
Whether to perform the operation in place on the data | ||
.. versionadded:: 0.21.0 | ||
Whether to perform the operation in place on the data. | ||
|
||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Keep the version added |
||
See Also | ||
-------- | ||
clip | ||
clip : Return input copy with values below/above thresholds truncated. | ||
clip_lower : Return input copy input with values below given thresholds. | ||
|
||
Returns | ||
------- | ||
clipped : same type as input | ||
|
||
Examples | ||
-------- | ||
>>> s = pd.Series([1,2,3,4,5,6,7]) | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. PEP-8 requires space after commas. Probably with few values it's more compact,and still shows the behavior. |
||
>>> s | ||
0 1 | ||
1 2 | ||
2 3 | ||
3 4 | ||
4 5 | ||
5 6 | ||
6 7 | ||
dtype: int64 | ||
|
||
>>> s.clip_upper(4) | ||
0 1 | ||
1 2 | ||
2 3 | ||
3 4 | ||
4 4 | ||
5 4 | ||
6 4 | ||
dtype: int64 | ||
|
||
>>> t = [4,8,7,2,5,4,6] | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. same with commas |
||
>>> t | ||
[4, 8, 7, 2, 5, 4, 6] | ||
|
||
>>> s.clip_upper(t) | ||
0 1 | ||
1 2 | ||
2 3 | ||
3 2 | ||
4 5 | ||
5 4 | ||
6 6 | ||
dtype: int64 | ||
""" | ||
return self._clip_with_one_bound(threshold, method=self.le, | ||
axis=axis, inplace=inplace) | ||
|
@@ -5661,18 +5705,21 @@ def clip_lower(self, threshold, axis=None, inplace=False): | |
""" | ||
Return copy of the input with values below given value(s) truncated. | ||
|
||
|
||
|
||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I think you didn't want to commit the changes to this pull request, did you? |
||
Parameters | ||
---------- | ||
threshold : float or array_like | ||
Minimun value allowed. All values below threshold will be | ||
equaled to the threshold value. | ||
axis : int or string axis name, optional | ||
Align object with threshold along the given axis. | ||
inplace : boolean, default False | ||
Whether to perform the operation in place on the data | ||
.. versionadded:: 0.21.0 | ||
Whether to perform the operation in place on the data. | ||
|
||
See Also | ||
-------- | ||
clip | ||
clip: | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. missing description? I think the colon requires a space in the left. |
||
|
||
Returns | ||
------- | ||
|
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.
unnecessary break line.