Skip to content

Commit

Permalink
DOC: Fix numpy docstring validation errors in pandas.Series.skew (pan…
Browse files Browse the repository at this point in the history
…das-dev#59266)

adding a see also section to pandas.Series.skew
  • Loading branch information
mattbest authored Jul 17, 2024
1 parent 288af5f commit d8cfd52
Show file tree
Hide file tree
Showing 2 changed files with 9 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 @@ -158,7 +158,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
-i "pandas.Series.product RT03" \
-i "pandas.Series.reorder_levels RT03,SA01" \
-i "pandas.Series.sem PR01,RT03,SA01" \
-i "pandas.Series.skew SA01" \
-i "pandas.Series.sparse PR01,SA01" \
-i "pandas.Series.sparse.density SA01" \
-i "pandas.Series.sparse.fill_value SA01" \
Expand Down
10 changes: 9 additions & 1 deletion pandas/core/generic.py
Original file line number Diff line number Diff line change
Expand Up @@ -12481,6 +12481,14 @@ def last_valid_index(self) -> Hashable:
stat_func="min", verb="Min", default_output=0, level_output_0=2, level_output_1=0
)

_skew_see_also = """
See Also
--------
Series.skew : Return unbiased skew over requested axis.
Series.var : Return unbiased variance over requested axis.
Series.std : Return unbiased standard deviation over requested axis."""

_stat_func_see_also = """
See Also
Expand Down Expand Up @@ -12740,7 +12748,7 @@ def make_doc(name: str, ndim: int) -> str:
elif name == "skew":
base_doc = _num_doc
desc = "Return unbiased skew over requested axis.\n\nNormalized by N-1."
see_also = ""
see_also = _skew_see_also
examples = """
Examples
Expand Down

0 comments on commit d8cfd52

Please sign in to comment.