Skip to content

Commit 9bf0670

Browse files
authored
DOC Correcting EX02 errors (#51143)
* DOC Correcting EX02 errors * DOC Fixing EX02 error - issue with plot.line
1 parent 8cb6382 commit 9bf0670

File tree

2 files changed

+6
-6
lines changed

2 files changed

+6
-6
lines changed

ci/code_checks.sh

-4
Original file line numberDiff line numberDiff line change
@@ -579,8 +579,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
579579
MSG='Partially validate docstrings (EX02)' ; echo $MSG
580580
$BASE_DIR/scripts/validate_docstrings.py --format=actions --errors=EX02 --ignore_functions \
581581
pandas.DataFrame.plot.line \
582-
pandas.DataFrame.std \
583-
pandas.DataFrame.var \
584582
pandas.Index.factorize \
585583
pandas.Period.strftime \
586584
pandas.Series.factorize \
@@ -590,8 +588,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
590588
pandas.Series.sparse.density \
591589
pandas.Series.sparse.npoints \
592590
pandas.Series.sparse.sp_values \
593-
pandas.Series.std \
594-
pandas.Series.var \
595591
pandas.Timestamp.fromtimestamp \
596592
pandas.api.types.infer_dtype \
597593
pandas.api.types.is_bool_dtype \

pandas/core/generic.py

+6-2
Original file line numberDiff line numberDiff line change
@@ -11872,12 +11872,14 @@ def _doc_params(cls):
1187211872
>>> df.std()
1187311873
age 18.786076
1187411874
height 0.237417
11875+
dtype: float64
1187511876
1187611877
Alternatively, `ddof=0` can be set to normalize by N instead of N-1:
1187711878
1187811879
>>> df.std(ddof=0)
1187911880
age 16.269219
11880-
height 0.205609"""
11881+
height 0.205609
11882+
dtype: float64"""
1188111883

1188211884
_var_examples = """
1188311885
@@ -11898,12 +11900,14 @@ def _doc_params(cls):
1189811900
>>> df.var()
1189911901
age 352.916667
1190011902
height 0.056367
11903+
dtype: float64
1190111904
1190211905
Alternatively, ``ddof=0`` can be set to normalize by N instead of N-1:
1190311906
1190411907
>>> df.var(ddof=0)
1190511908
age 264.687500
11906-
height 0.042275"""
11909+
height 0.042275
11910+
dtype: float64"""
1190711911

1190811912
_bool_doc = """
1190911913
{desc}

0 commit comments

Comments
 (0)