From 5d9408e9b838fc1ca5f189bbac09b8dff966c57e Mon Sep 17 00:00:00 2001 From: Brett Dixon Date: Sun, 26 May 2024 02:46:42 +0000 Subject: [PATCH 1/3] added see also to docstrings --- pandas/core/generic.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/pandas/core/generic.py b/pandas/core/generic.py index ca60ca9b48a14..a11fddea08ee0 100644 --- a/pandas/core/generic.py +++ b/pandas/core/generic.py @@ -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 @@ -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 @@ -12715,7 +12715,7 @@ def make_doc(name: str, ndim: int) -> str: dtype: float64""" see_also = "" kwargs = {"notes": ""} - + elif name == "skew": base_doc = _num_doc desc = "Return unbiased skew over requested axis.\n\nNormalized by N-1." From e795f20c75ec8dc0caee43b42bc0bdd669da9e4c Mon Sep 17 00:00:00 2001 From: Brett Dixon Date: Sat, 8 Jun 2024 16:43:26 +0000 Subject: [PATCH 2/3] fixed typing --- pandas/core/generic.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/pandas/core/generic.py b/pandas/core/generic.py index a11fddea08ee0..7c50285726982 100644 --- a/pandas/core/generic.py +++ b/pandas/core/generic.py @@ -12715,7 +12715,7 @@ def make_doc(name: str, ndim: int) -> str: dtype: float64""" see_also = "" kwargs = {"notes": ""} - + elif name == "skew": base_doc = _num_doc desc = "Return unbiased skew over requested axis.\n\nNormalized by N-1." @@ -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 = ( From 5285228c2fb905b3e863175cc9f7afa78271a1e0 Mon Sep 17 00:00:00 2001 From: Brett Dixon Date: Mon, 10 Jun 2024 00:57:43 +0000 Subject: [PATCH 3/3] Updated code check --- ci/code_checks.sh | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/ci/code_checks.sh b/ci/code_checks.sh index a93e23a0f5022..989704b7f76d2 100755 --- a/ci/code_checks.sh +++ b/ci/code_checks.sh @@ -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,SA01" \ -i "pandas.Grouper PR02" \