Skip to content

Commit

Permalink
DOC: added see also to docstrings in mean and median (#58951)
Browse files Browse the repository at this point in the history
* added see also to docstrings

* fixed typing

* Updated code check
  • Loading branch information
Brett-Dixon authored Jun 10, 2024
1 parent 2d1e59d commit 5411cc4
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 4 deletions.
4 changes: 2 additions & 2 deletions ci/code_checks.sh
Original file line number Diff line number Diff line change
Expand Up @@ -71,8 +71,8 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
-i ES01 `# For now it is ok if docstrings are missing the extended summary` \
-i "pandas.Series.dt PR01" `# Accessors are implemented as classes, but we do not document the Parameters section` \
-i "pandas.DataFrame.max RT03" \
-i "pandas.DataFrame.mean RT03,SA01" \
-i "pandas.DataFrame.median RT03,SA01" \
-i "pandas.DataFrame.mean RT03" \
-i "pandas.DataFrame.median RT03" \
-i "pandas.DataFrame.min RT03" \
-i "pandas.DataFrame.plot PR02" \
-i "pandas.Grouper PR02" \
Expand Down
5 changes: 3 additions & 2 deletions pandas/core/generic.py
Original file line number Diff line number Diff line change
Expand Up @@ -12571,7 +12571,7 @@ def make_doc(name: str, ndim: int) -> str:
elif name == "median":
base_doc = _num_doc
desc = "Return the median of the values over the requested axis."
see_also = ""
see_also = _stat_func_see_also
examples = """
Examples
Expand Down Expand Up @@ -12612,7 +12612,7 @@ def make_doc(name: str, ndim: int) -> str:
elif name == "mean":
base_doc = _num_doc
desc = "Return the mean of the values over the requested axis."
see_also = ""
see_also = _stat_func_see_also
examples = """
Examples
Expand Down Expand Up @@ -12760,6 +12760,7 @@ def make_doc(name: str, ndim: int) -> str:
a 0.0
dtype: float64"""
kwargs = {"min_count": ""}

elif name == "kurt":
base_doc = _num_doc
desc = (
Expand Down

0 comments on commit 5411cc4

Please sign in to comment.