Skip to content

Commit

Permalink
DOC: Enforce Numpy Docstring Validation for pandas.Series.add (#58673)
Browse files Browse the repository at this point in the history
* DOC: add PR07 pandas.Series.add

* DOC: remove PR07 pandas.Series.add
  • Loading branch information
tuhinsharma121 committed May 11, 2024
1 parent 8500629 commit 15741ca
Show file tree
Hide file tree
Showing 2 changed files with 57 additions and 2 deletions.
1 change: 0 additions & 1 deletion ci/code_checks.sh
Expand Up @@ -141,7 +141,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
-i "pandas.RangeIndex.start SA01" \
-i "pandas.RangeIndex.step SA01" \
-i "pandas.RangeIndex.stop SA01" \
-i "pandas.Series.add PR07" \
-i "pandas.Series.case_when RT03" \
-i "pandas.Series.cat PR07" \
-i "pandas.Series.cat.add_categories PR01,PR02" \
Expand Down
58 changes: 57 additions & 1 deletion pandas/core/series.py
Expand Up @@ -5957,8 +5957,64 @@ def gt(self, other, level=None, fill_value=None, axis: Axis = 0) -> Series:
other, operator.gt, level=level, fill_value=fill_value, axis=axis
)

@Appender(ops.make_flex_doc("add", "series"))
def add(self, other, level=None, fill_value=None, axis: Axis = 0) -> Series:
"""
Return Addition of series and other, element-wise (binary operator `add`).
Equivalent to ``series + other``, but with support to substitute a fill_value
for missing data in either one of the inputs.
Parameters
----------
other : Series or scalar value
With which to compute the addition.
level : int or name
Broadcast across a level, matching Index values on the
passed MultiIndex level.
fill_value : None or float value, default None (NaN)
Fill existing missing (NaN) values, and any new element needed for
successful Series alignment, with this value before computation.
If data in both corresponding Series locations is missing
the result of filling (at that location) will be missing.
axis : {0 or 'index'}
Unused. Parameter needed for compatibility with DataFrame.
Returns
-------
Series
The result of the operation.
See Also
--------
Series.radd : Reverse of the Addition operator, see
`Python documentation
<https://docs.python.org/3/reference/datamodel.html#emulating-numeric-types>`_
for more details.
Examples
--------
>>> a = pd.Series([1, 1, 1, np.nan], index=["a", "b", "c", "d"])
>>> a
a 1.0
b 1.0
c 1.0
d NaN
dtype: float64
>>> b = pd.Series([1, np.nan, 1, np.nan], index=["a", "b", "d", "e"])
>>> b
a 1.0
b NaN
d 1.0
e NaN
dtype: float64
>>> a.add(b, fill_value=0)
a 2.0
b 1.0
c 1.0
d 1.0
e NaN
dtype: float64
"""
return self._flex_method(
other, operator.add, level=level, fill_value=fill_value, axis=axis
)
Expand Down

0 comments on commit 15741ca

Please sign in to comment.