Skip to content

Commit f26bf27

Browse files
authored
DOC Fix EX01 issues in docstrings (pandas-dev#51561)
DOC Fix EX01 errors
1 parent b11e0db commit f26bf27

File tree

2 files changed

+42
-5
lines changed

2 files changed

+42
-5
lines changed

ci/code_checks.sh

-4
Original file line numberDiff line numberDiff line change
@@ -92,13 +92,11 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
9292
pandas.Series.keys \
9393
pandas.Series.item \
9494
pandas.Series.pipe \
95-
pandas.Series.kurt \
9695
pandas.Series.mean \
9796
pandas.Series.median \
9897
pandas.Series.mode \
9998
pandas.Series.sem \
10099
pandas.Series.skew \
101-
pandas.Series.kurtosis \
102100
pandas.Series.is_unique \
103101
pandas.Series.is_monotonic_increasing \
104102
pandas.Series.is_monotonic_decreasing \
@@ -545,8 +543,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
545543
pandas.DataFrame.keys \
546544
pandas.DataFrame.iterrows \
547545
pandas.DataFrame.pipe \
548-
pandas.DataFrame.kurt \
549-
pandas.DataFrame.kurtosis \
550546
pandas.DataFrame.mean \
551547
pandas.DataFrame.median \
552548
pandas.DataFrame.sem \

pandas/core/generic.py

+42-1
Original file line numberDiff line numberDiff line change
@@ -11561,7 +11561,48 @@ def skew(
1156111561
axis_descr=axis_descr,
1156211562
min_count="",
1156311563
see_also="",
11564-
examples="",
11564+
examples="""
11565+
11566+
Examples
11567+
--------
11568+
>>> s = pd.Series([1, 2, 2, 3], index=['cat', 'dog', 'dog', 'mouse'])
11569+
>>> s
11570+
cat 1
11571+
dog 2
11572+
dog 2
11573+
mouse 3
11574+
dtype: int64
11575+
>>> s.kurt()
11576+
1.5
11577+
11578+
With a DataFrame
11579+
11580+
>>> df = pd.DataFrame({'a': [1, 2, 2, 3], 'b': [3, 4, 4, 4]},
11581+
... index=['cat', 'dog', 'dog', 'mouse'])
11582+
>>> df
11583+
a b
11584+
cat 1 3
11585+
dog 2 4
11586+
dog 2 4
11587+
mouse 3 4
11588+
>>> df.kurt()
11589+
a 1.5
11590+
b 4.0
11591+
dtype: float64
11592+
11593+
With axis=None
11594+
11595+
>>> df.kurt(axis=None).round(6)
11596+
-0.988693
11597+
11598+
Using axis=1
11599+
11600+
>>> df = pd.DataFrame({'a': [1, 2], 'b': [3, 4], 'c': [3, 4], 'd': [1, 2]},
11601+
... index=['cat', 'dog'])
11602+
>>> df.kurt(axis=1)
11603+
cat -6.0
11604+
dog -6.0
11605+
dtype: float64""",
1156511606
)
1156611607
def kurt(
1156711608
self,

0 commit comments

Comments
 (0)