Skip to content

Commit 5411cc4

Browse files
authored
DOC: added see also to docstrings in mean and median (#58951)
* added see also to docstrings * fixed typing * Updated code check
1 parent 2d1e59d commit 5411cc4

File tree

2 files changed

+5
-4
lines changed

2 files changed

+5
-4
lines changed

ci/code_checks.sh

+2-2
Original file line numberDiff line numberDiff line change
@@ -71,8 +71,8 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
7171
-i ES01 `# For now it is ok if docstrings are missing the extended summary` \
7272
-i "pandas.Series.dt PR01" `# Accessors are implemented as classes, but we do not document the Parameters section` \
7373
-i "pandas.DataFrame.max RT03" \
74-
-i "pandas.DataFrame.mean RT03,SA01" \
75-
-i "pandas.DataFrame.median RT03,SA01" \
74+
-i "pandas.DataFrame.mean RT03" \
75+
-i "pandas.DataFrame.median RT03" \
7676
-i "pandas.DataFrame.min RT03" \
7777
-i "pandas.DataFrame.plot PR02" \
7878
-i "pandas.Grouper PR02" \

pandas/core/generic.py

+3-2
Original file line numberDiff line numberDiff line change
@@ -12571,7 +12571,7 @@ def make_doc(name: str, ndim: int) -> str:
1257112571
elif name == "median":
1257212572
base_doc = _num_doc
1257312573
desc = "Return the median of the values over the requested axis."
12574-
see_also = ""
12574+
see_also = _stat_func_see_also
1257512575
examples = """
1257612576
1257712577
Examples
@@ -12612,7 +12612,7 @@ def make_doc(name: str, ndim: int) -> str:
1261212612
elif name == "mean":
1261312613
base_doc = _num_doc
1261412614
desc = "Return the mean of the values over the requested axis."
12615-
see_also = ""
12615+
see_also = _stat_func_see_also
1261612616
examples = """
1261712617
1261812618
Examples
@@ -12760,6 +12760,7 @@ def make_doc(name: str, ndim: int) -> str:
1276012760
a 0.0
1276112761
dtype: float64"""
1276212762
kwargs = {"min_count": ""}
12763+
1276312764
elif name == "kurt":
1276412765
base_doc = _num_doc
1276512766
desc = (

0 commit comments

Comments
 (0)