Skip to content

Commit

Permalink
DOC: Add SA01 for pandas.Series.le (#58755)
Browse files Browse the repository at this point in the history
* DOC: add SA01 for pandas.Series.le

* DOC: remove SA01 for pandas.Series.le
  • Loading branch information
tuhinsharma121 committed May 17, 2024
1 parent 62e95db commit 2753b17
Show file tree
Hide file tree
Showing 2 changed files with 61 additions and 2 deletions.
1 change: 0 additions & 1 deletion ci/code_checks.sh
Original file line number Diff line number Diff line change
Expand Up @@ -169,7 +169,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
-i "pandas.Series.gt SA01" \
-i "pandas.Series.kurt RT03,SA01" \
-i "pandas.Series.kurtosis RT03,SA01" \
-i "pandas.Series.le SA01" \
-i "pandas.Series.list.__getitem__ SA01" \
-i "pandas.Series.list.flatten SA01" \
-i "pandas.Series.list.len SA01" \
Expand Down
62 changes: 61 additions & 1 deletion pandas/core/series.py
Original file line number Diff line number Diff line change
Expand Up @@ -5930,8 +5930,68 @@ def ne(self, other, level=None, fill_value=None, axis: Axis = 0) -> Series:
other, operator.ne, level=level, fill_value=fill_value, axis=axis
)

@Appender(ops.make_flex_doc("le", "series"))
def le(self, other, level=None, fill_value=None, axis: Axis = 0) -> Series:
"""
Return Less than or equal to of series and other, \
element-wise (binary operator `le`).
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
The second operand in this operation.
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.ge : Return elementwise Greater than or equal to of series and other.
Series.lt : Return elementwise Less than of series and other.
Series.gt : Return elementwise Greater than of series and other.
Series.eq : Return elementwise equal to of series and other.
Examples
--------
>>> a = pd.Series([1, 1, 1, np.nan, 1], index=['a', 'b', 'c', 'd', 'e'])
>>> a
a 1.0
b 1.0
c 1.0
d NaN
e 1.0
dtype: float64
>>> b = pd.Series([0, 1, 2, np.nan, 1], index=['a', 'b', 'c', 'd', 'f'])
>>> b
a 0.0
b 1.0
c 2.0
d NaN
f 1.0
dtype: float64
>>> a.le(b, fill_value=0)
a False
b True
c True
d False
e False
f True
dtype: bool
"""
return self._flex_method(
other, operator.le, level=level, fill_value=fill_value, axis=axis
)
Expand Down

0 comments on commit 2753b17

Please sign in to comment.