Skip to content

DOC: fix EX03 errors in docstrings - pandas.core.resample.Resampler.interpolate, pandas.pivot, pandas.merge_asof, pandas.wide_to_long #56868

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.

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 2 commits into from
Jan 15, 2024

Conversation

jordan-d-murphy
Copy link
Contributor

All EX03 Errors resolved in the following cases:

  1. scripts/validate_docstrings.py --format=actions --errors=EX03 pandas.core.resample.Resampler.interpolate
  2. scripts/validate_docstrings.py --format=actions --errors=EX03 pandas.pivot
  3. scripts/validate_docstrings.py --format=actions --errors=EX03 pandas.merge_asof
  4. scripts/validate_docstrings.py --format=actions --errors=EX03 pandas.wide_to_long

Output:

  1. scripts/validate_docstrings.py --format=actions --errors=EX03 pandas.core.resample.Resampler.interpolate
################################################################################
################################## Validation ##################################
################################################################################

2 Errors found for `pandas.core.resample.Resampler.interpolate`:
	Parameters {'**kwargs'} not documented
	Unknown parameters {'``**kwargs``'}
  1. scripts/validate_docstrings.py --format=actions --errors=EX03 pandas.pivot
################################################################################
################################## Validation ##################################
################################################################################

1 Errors found for `pandas.pivot`:
	Parameter "data" has no description
  1. scripts/validate_docstrings.py --format=actions --errors=EX03 pandas.merge_asof
################################################################################
################################## Validation ##################################
################################################################################

3 Errors found for `pandas.merge_asof`:
	Parameter "left" has no description
	Parameter "right" has no description
	Return value has no description
  1. scripts/validate_docstrings.py --format=actions --errors=EX03 pandas.wide_to_long
################################################################################
################################## Validation ##################################
################################################################################

Docstring for "pandas.wide_to_long" correct. :)

…nterpolate, pandas.pivot, pandas.merge_asof, pandas.wide_to_long
@datapythonista datapythonista merged commit a0634c9 into pandas-dev:main Jan 15, 2024
@datapythonista
Copy link
Member

Thanks @jordan-d-murphy, nice clean up

@jordan-d-murphy jordan-d-murphy deleted the issue#56804_5 branch January 15, 2024 23:17
pmhatre1 pushed a commit to pmhatre1/pandas-pmhatre1 that referenced this pull request May 7, 2024
…nterpolate, pandas.pivot, pandas.merge_asof, pandas.wide_to_long (pandas-dev#56868)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants