DOC: improved the docstring of pandas.Series.clip_upper improved #20135
Conversation
|
Hello @jalazbe! Thanks for updating the PR. Cheers ! There are no PEP8 issues in this Pull Request. 🍻 Comment last updated on July 08, 2018 at 14:47 Hours UTC |
PEP8 corrections
| 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. |
pandas/core/generic.py
Outdated
| Parameters | ||
| ---------- | ||
| threshold : float or array_like |
There was a problem hiding this comment.
I think we use array-like (with hyphen)
| 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.
we use bool instead of boolean
| Whether to perform the operation in place on the data | ||
| .. versionadded:: 0.21.0 | ||
| Whether to perform the operation in place on the data. | ||
pandas/core/generic.py
Outdated
| Examples | ||
| -------- | ||
| >>> s = pd.Series([1,2,3,4,5,6,7]) |
There was a problem hiding this comment.
PEP-8 requires space after commas. Probably with few values it's more compact,and still shows the behavior.
pandas/core/generic.py
Outdated
| 6 4 | ||
| dtype: int64 | ||
| >>> t = [4,8,7,2,5,4,6] |
| Return copy of the input with values below given value(s) truncated. | ||
There was a problem hiding this comment.
I think you didn't want to commit the changes to this pull request, did you?
pandas/core/generic.py
Outdated
| See Also | ||
| -------- | ||
| clip | ||
| clip: |
There was a problem hiding this comment.
missing description? I think the colon requires a space in the left.
PEP-8 correctios
Codecov Report
@@ Coverage Diff @@
## master #20135 +/- ##
=========================================
Coverage ? 91.72%
=========================================
Files ? 150
Lines ? 49152
Branches ? 0
=========================================
Hits ? 45086
Misses ? 4066
Partials ? 0
Continue to review full report at Codecov.
|
WillAyd
force-pushed
the
sprint_madrid_clip_upper
branch
from
085f537 to
a77b491
Compare
|
Thanks @jalazbe ! |
(pandas_dev) C:\Users\Jaime\repos\MadrisSprintPandas\pandas\scripts>python validate_docstrings.py pandas.Series.clip_upper
################################################################################
##################### Docstring (pandas.Series.clip_upper) #####################
################################################################################
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
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
Whether to perform the operation in place on the data.
See Also
clip : Return copy of input with values below/above thresholds truncated.
clip_lower : Return copy of input with values below given thresholds.
Returns
clipped : same type as input
Examples
################################################################################
################################## Validation ##################################
################################################################################
Docstring for "pandas.Series.clip_upper" correct. :)