DOC: fix EX03 errors in docstrings

[natmokval]

pandas has a script for validating docstrings

pandas/ci/code_checks.sh

Lines 72 to 172 in b7e2202

	MSG='Partially validate docstrings (EX03)' ; echo $MSG
	$BASE_DIR/scripts/validate_docstrings.py --format=actions --errors=EX03 --ignore_functions \
	pandas.Series.dt.day_name \
	pandas.Series.str.len \
	pandas.Series.cat.set_categories \
	pandas.Series.plot.bar \
	pandas.Series.plot.hist \
	pandas.Series.plot.line \
	pandas.Series.to_sql \
	pandas.Series.to_latex \
	pandas.errors.CategoricalConversionWarning \
	pandas.errors.ChainedAssignmentError \
	pandas.errors.ClosedFileError \
	pandas.errors.DatabaseError \
	pandas.errors.IndexingError \
	pandas.errors.InvalidColumnName \
	pandas.errors.NumExprClobberingError \
	pandas.errors.PossibleDataLossError \
	pandas.errors.PossiblePrecisionLoss \
	pandas.errors.SettingWithCopyError \
	pandas.errors.SettingWithCopyWarning \
	pandas.errors.SpecificationError \
	pandas.errors.UndefinedVariableError \
	pandas.errors.ValueLabelTypeMismatch \
	pandas.Timestamp.ceil \
	pandas.Timestamp.floor \
	pandas.Timestamp.round \
	pandas.read_pickle \
	pandas.ExcelWriter \
	pandas.read_json \
	pandas.io.json.build_table_schema \
	pandas.DataFrame.to_latex \
	pandas.io.formats.style.Styler.to_latex \
	pandas.read_parquet \
	pandas.DataFrame.to_sql \
	pandas.read_stata \
	pandas.core.resample.Resampler.pipe \
	pandas.core.resample.Resampler.fillna \
	pandas.core.resample.Resampler.interpolate \
	pandas.plotting.scatter_matrix \
	pandas.pivot \
	pandas.merge_asof \
	pandas.wide_to_long \
	pandas.Index.rename \
	pandas.Index.droplevel \
	pandas.Index.isin \
	pandas.CategoricalIndex.set_categories \
	pandas.MultiIndex.names \
	pandas.MultiIndex.droplevel \
	pandas.IndexSlice \
	pandas.DatetimeIndex.month_name \
	pandas.DatetimeIndex.day_name \
	pandas.core.window.rolling.Rolling.corr \
	pandas.Grouper \
	pandas.core.groupby.SeriesGroupBy.apply \
	pandas.core.groupby.DataFrameGroupBy.apply \
	pandas.core.groupby.SeriesGroupBy.transform \
	pandas.core.groupby.SeriesGroupBy.pipe \
	pandas.core.groupby.DataFrameGroupBy.pipe \
	pandas.core.groupby.DataFrameGroupBy.describe \
	pandas.core.groupby.DataFrameGroupBy.idxmax \
	pandas.core.groupby.DataFrameGroupBy.idxmin \
	pandas.core.groupby.DataFrameGroupBy.value_counts \
	pandas.core.groupby.SeriesGroupBy.describe \
	pandas.core.groupby.DataFrameGroupBy.boxplot \
	pandas.core.groupby.DataFrameGroupBy.hist \
	pandas.io.formats.style.Styler.map \
	pandas.io.formats.style.Styler.apply_index \
	pandas.io.formats.style.Styler.map_index \
	pandas.io.formats.style.Styler.format \
	pandas.io.formats.style.Styler.format_index \
	pandas.io.formats.style.Styler.relabel_index \
	pandas.io.formats.style.Styler.hide \
	pandas.io.formats.style.Styler.set_td_classes \
	pandas.io.formats.style.Styler.set_tooltips \
	pandas.io.formats.style.Styler.set_uuid \
	pandas.io.formats.style.Styler.pipe \
	pandas.io.formats.style.Styler.highlight_between \
	pandas.io.formats.style.Styler.highlight_quantile \
	pandas.io.formats.style.Styler.background_gradient \
	pandas.io.formats.style.Styler.text_gradient \
	pandas.DataFrame.values \
	pandas.DataFrame.loc \
	pandas.DataFrame.iloc \
	pandas.DataFrame.groupby \
	pandas.DataFrame.describe \
	pandas.DataFrame.skew \
	pandas.DataFrame.var \
	pandas.DataFrame.idxmax \
	pandas.DataFrame.idxmin \
	pandas.DataFrame.last \
	pandas.DataFrame.pivot \
	pandas.DataFrame.sort_values \
	pandas.DataFrame.tz_convert \
	pandas.DataFrame.tz_localize \
	pandas.DataFrame.plot.bar \
	pandas.DataFrame.plot.hexbin \
	pandas.DataFrame.plot.hist \
	pandas.DataFrame.plot.line \
	pandas.DataFrame.hist \
	RET=$(($RET + $?)) ; echo $MSG "DONE"

Currently, some methods fail the EX03 check.

The task here is:

• take 2-4 methods
• run: scripts/validate_docstrings.py --format=actions --errors=EX03 method-name
• check if validation docstrings passes for those methods, and if it’s necessary fix the docstrings according to whatever error is reported
• remove those methods from code_checks.sh
• commit, push, open pull request

Please don't comment take as multiple people can work on this issue. You also don't need to ask for permission to work on this, just comment on which methods are you going to work.

If you're new contributor, please check the contributing guide

thanks @MarcoGorelli for giving me the idea for this issue.

[roadrollerdafjorst]

I can take the first two methods.

• pandas.Series.dt.day_name
• pandas.Series.str.len

[luke396]

I will work for:
pandas.Series.cat.set_categories
pandas.Series.plot.bar
pandas.Series.plot.hist

[luke396]

Just to be sure, and to clarify for later contributors, the error EX03 refers to all possible flake8 errors.

Reference #27977.

[svrashank]

Working on :

• pandas.Series.plot.line
• pandas.Series.to_sql

[Deekshita-S]

working on:

• pandas.DataFrame.loc
• pandas.DataFrame.iloc
• pandas.DataFrame.describe

[asishm]

I wrote a comment but accidentally deleted it 🤦‍♂️

tl;dr - if a method is passed to validate_docstrings.py it ignores all the other arguments and returns all errors.

[lukasld]

Im new to this and maybe I overlook something fundamental:
I wanted to take on some of these docstrings, I however run into an issue and am not sure what I am doing wrong.

After executing:

python3 validate_docstrings.py --format=actions --errors=EX03 pandas.errors.SpecificationError

I get a list of flake8 - errors:

flake8 error: line 4, col 40: E261 at least two spaces before inline comment
...

However, after adding an extra space and saving the docstring for SpecificationError in this case in

./pandas/errors/__init__.py

and rerunning the above validation_docstrings.py again, the script returns the same errors, as if the change had no effect.

[lukasld]

Otherwise id take:

• pandas.errors.SettingWithCopyWarning
• pandas.errors.SpecificationError
• pandas.errors.UndefinedVariableError

[tiffanyxiao]

Working on:

• pandas.errors.DatabaseError
• pandas.errors.IndexingError
• pandas.errors.InvalidColumnName
  Thank you!

[svrashank]

So for pandas.Series.plot.line its giving following errors:

• Unknown parameters {'color'}
• flake8 error: line 4, col 4: E121 continuation line under-indented for hanging indent
• flake8 error: line 6, col 4: E123 closing bracket does not match indentation of opening bracket's line
  I am new to this , can someone help me in understanding 'line 4,col 4' of what ? I can't seem to locate where it is pointing me towards. Thanks in advance