DOC: ex03 - no fix required

[asishm]

• xref DOC: fix EX03 errors in docstrings #56804

Used this script to validate:

import subprocess as sp

def validate_func(func_name):
    proc = sp.Popen(['./scripts/validate_docstrings.py', '--errors=EX03', func_name], stdout=sp.PIPE, stderr=sp.PIPE)
    proc.wait()
    out = proc.stderr.read().decode().strip()
    return out.endswith(f'Docstring for "{func_name}" correct. :)')

funcs = ['pandas.DataFrame.var',
 'pandas.DatetimeIndex.day_name',
 'pandas.core.groupby.DataFrameGroupBy.apply',
 'pandas.DatetimeIndex.month_name',
 'pandas.core.groupby.DataFrameGroupBy.hist',
 'pandas.core.groupby.SeriesGroupBy.apply',
 'pandas.core.groupby.SeriesGroupBy.transform',
 'pandas.DataFrame.hist',
 'pandas.DataFrame.tz_localize',
 'pandas.CategoricalIndex.set_categories',
 'pandas.core.groupby.DataFrameGroupBy.boxplot',
 'pandas.core.groupby.SeriesGroupBy.pipe',
 'pandas.DataFrame.plot.bar',
 'pandas.DataFrame.tz_convert',
 'pandas.core.groupby.DataFrameGroupBy.pipe',
 'pandas.DataFrame.skew',
 'pandas.core.window.rolling.Rolling.corr']

for func in funcs:
    print(func, validate_func(func))

Let me know if it's too many at once.

[mroeschke]

Thanks @asishm

[erichxchen]

Wait! For the function 'pandas.DataFrame.hist', my output for this function is

################################################################################
################################## Validation ##################################
################################################################################

1 Errors found for `pandas.DataFrame.hist`:
        Return value has no description

I have created a PR to fix this: #56864

[erichxchen]

NVM, just find out scripts/validate_docstrings.py --format=actions --errors=EX03 method-name will output all errors not only the EX03 error if only provide one method name.

pandas/scripts/validate_docstrings.py

Lines 444 to 457 in c778746

	def main(func_name, prefix, errors, output_format, ignore_deprecated, ignore_functions):
	"""
	Main entry point. Call the validation for one or for all docstrings.
	"""
	if func_name is None:
	return print_validate_all_results(
	prefix,
	errors,
	output_format,
	ignore_deprecated,
	ignore_functions,
	)
	else:
	print_validate_one_results(func_name)

Also mentioned here #56804 (comment)