Skip to content

DOC Correcting EX02 errors #51143

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Feb 3, 2023
Merged

DOC Correcting EX02 errors #51143

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
cdf7dbc
DOC Correcting EX02 errors
DeaMariaLeon Feb 3, 2023
9c1444a
DOC Correcting EX02 errors
DeaMariaLeon Feb 3, 2023
8d4ca40
Merge
DeaMariaLeon Feb 3, 2023
4ce52f1
DOC Fixing EX02 error - issue with plot.line
DeaMariaLeon Feb 3, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 0 additions & 4 deletions ci/code_checks.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -579,8 +579,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
MSG='Partially validate docstrings (EX02)' ; echo $MSG
$BASE_DIR/scripts/validate_docstrings.py --format=actions --errors=EX02 --ignore_functions \
pandas.DataFrame.plot.line \
pandas.DataFrame.std \
pandas.DataFrame.var \
pandas.Index.factorize \
pandas.Period.strftime \
pandas.Series.factorize \
Expand All @@ -590,8 +588,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
pandas.Series.sparse.density \
pandas.Series.sparse.npoints \
pandas.Series.sparse.sp_values \
pandas.Series.std \
pandas.Series.var \
pandas.Timestamp.fromtimestamp \
pandas.api.types.infer_dtype \
pandas.api.types.is_bool_dtype \
Expand Down
8 changes: 6 additions & 2 deletions pandas/core/generic.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11872,12 +11872,14 @@ def _doc_params(cls):
>>> df.std()
age 18.786076
height 0.237417
dtype: float64

Alternatively, `ddof=0` can be set to normalize by N instead of N-1:

>>> df.std(ddof=0)
age 16.269219
height 0.205609"""
height 0.205609
dtype: float64"""

_var_examples = """

Expand All @@ -11898,12 +11900,14 @@ def _doc_params(cls):
>>> df.var()
age 352.916667
height 0.056367
dtype: float64

Alternatively, ``ddof=0`` can be set to normalize by N instead of N-1:

>>> df.var(ddof=0)
age 264.687500
height 0.042275"""
height 0.042275
dtype: float64"""

_bool_doc = """
{desc}
Expand Down