DOC: improved the docstring of pandas.Series.clip_upper improved
State: closed

(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
--------
>>> s = pd.Series([1,2,3,4,5,6,7])
>>> 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]
>>> 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

################################################################################
################################## Validation ##################################
################################################################################

Docstring for "pandas.Series.clip_upper" correct. :)


Labels:
name: Docs

Comments:
Hello @jalazbe! Thanks for updating the PR.



Cheers ! There are no PEP8 issues in this Pull Request. :beers: 

##### Comment last updated on July 08, 2018 at 14:47 Hours UTC
# [Codecov](https://codecov.io/gh/pandas-dev/pandas/pull/20135?src=pr&el=h1) Report
> :exclamation: No coverage uploaded for pull request base (`master@28378fd`). [Click here to learn what that means](https://docs.codecov.io/docs/error-reference#section-missing-base-commit).
> The diff coverage is `100%`.

[![Impacted file tree graph](https://codecov.io/gh/pandas-dev/pandas/pull/20135/graphs/tree.svg?height=150&width=650&token=eZ4WkYLtcO&src=pr)](https://codecov.io/gh/pandas-dev/pandas/pull/20135?src=pr&el=tree)

```diff
@@            Coverage Diff            @@
##             master   #20135   +/-   ##
=========================================
  Coverage          ?   91.72%           
=========================================
  Files             ?      150           
  Lines             ?    49152           
  Branches          ?        0           
=========================================
  Hits              ?    45086           
  Misses            ?     4066           
  Partials          ?        0
```

| Flag | Coverage Δ | |
|---|---|---|
| #multiple | `90.11% <100%> (?)` | |
| #single | `41.84% <4.76%> (?)` | |

| [Impacted Files](https://codecov.io/gh/pandas-dev/pandas/pull/20135?src=pr&el=tree) | Coverage Δ | |
|---|---|---|
| [pandas/core/generic.py](https://codecov.io/gh/pandas-dev/pandas/pull/20135/diff?src=pr&el=tree#diff-cGFuZGFzL2NvcmUvZ2VuZXJpYy5weQ==) | `95.84% <100%> (ø)` | |

------

[Continue to review full report at Codecov](https://codecov.io/gh/pandas-dev/pandas/pull/20135?src=pr&el=continue).
> **Legend** - [Click here to learn more](https://docs.codecov.io/docs/codecov-delta)
> `Δ = absolute <relative> (impact)`, `ø = not affected`, `? = missing data`
> Powered by [Codecov](https://codecov.io/gh/pandas-dev/pandas/pull/20135?src=pr&el=footer). Last update [28378fd...a77b491](https://codecov.io/gh/pandas-dev/pandas/pull/20135?src=pr&el=lastupdated). Read the [comment docs](https://docs.codecov.io/docs/pull-request-comments).

Thanks @jalazbe !