Skip to content

Commit 96ef51e

Browse files
DOC: Enforce Numpy Docstring Validation for pandas.Series.mode (#58627)
* DOC: remove SA01 for pandas.Series.mode * DOC: remove SA01 for pandas.Series.mode
1 parent 5a617b1 commit 96ef51e

File tree

2 files changed

+10
-1
lines changed

2 files changed

+10
-1
lines changed

ci/code_checks.sh

-1
Original file line numberDiff line numberDiff line change
@@ -192,7 +192,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
192192
-i "pandas.Series.list.flatten SA01" \
193193
-i "pandas.Series.list.len SA01" \
194194
-i "pandas.Series.lt PR07,SA01" \
195-
-i "pandas.Series.mode SA01" \
196195
-i "pandas.Series.ne PR07,SA01" \
197196
-i "pandas.Series.pad PR01,SA01" \
198197
-i "pandas.Series.plot PR02,SA01" \

pandas/core/series.py

+10
Original file line numberDiff line numberDiff line change
@@ -1957,6 +1957,16 @@ def mode(self, dropna: bool = True) -> Series:
19571957
Series
19581958
Modes of the Series in sorted order.
19591959
1960+
See Also
1961+
--------
1962+
numpy.mode : Equivalent numpy function for computing median.
1963+
Series.sum : Sum of the values.
1964+
Series.median : Median of the values.
1965+
Series.std : Standard deviation of the values.
1966+
Series.var : Variance of the values.
1967+
Series.min : Minimum value.
1968+
Series.max : Maximum value.
1969+
19601970
Examples
19611971
--------
19621972
>>> s = pd.Series([2, 4, 2, 2, 4, None])

0 commit comments

Comments
 (0)