Skip to content
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

Jump to bottom

DOC: fix PR02 errors in docstrings - pandas.Series.interpolate, pandas.read_hdf, pandas.HDFStore.append #57114

Merged
merged 2 commits into from
Jan 29, 2024
Merged

DOC: fix PR02 errors in docstrings - pandas.Series.interpolate, pandas.read_hdf, pandas.HDFStore.append #57114

merged 2 commits into from
Jan 29, 2024

Conversation

jordan-d-murphy
Copy link
Contributor

All PR02 Errors resolved in the following cases:

  1. scripts/validate_docstrings.py --format=actions --errors=PR02 pandas.Series.interpolate
  2. scripts/validate_docstrings.py --format=actions --errors=PR02 pandas.read_hdf
  3. scripts/validate_docstrings.py --format=actions --errors=PR02 pandas.HDFStore.append

OUTPUT:

  1. scripts/validate_docstrings.py --format=actions --errors=PR02 pandas.Series.interpolate
################################################################################
################################## Validation ##################################
################################################################################

Docstring for "pandas.Series.interpolate" correct. :)
  1. scripts/validate_docstrings.py --format=actions --errors=PR02 pandas.read_hdf
################################################################################
################################## Validation ##################################
################################################################################

Docstring for "pandas.read_hdf" correct. :)
  1. scripts/validate_docstrings.py --format=actions --errors=PR02 pandas.HDFStore.append
################################################################################
################################## Validation ##################################
################################################################################

8 Errors found for `pandas.HDFStore.append`:
	PR01	Parameters {'complib', 'complevel', 'axes', 'columns', 'errors'} not documented
	PR07	Parameter "key" has no description
	PR07	Parameter "min_itemsize" has no description
	PR07	Parameter "nan_rep" has no description
	PR07	Parameter "chunksize" has no description
	PR07	Parameter "expectedrows" has no description
	PR07	Parameter "encoding" has no description
	SA01	See Also section not found

datapythonista
datapythonista approved these changes Jan 29, 2024
View reviewed changes
Copy link
Member

@datapythonista datapythonista left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great, thanks @jordan-d-murphy. I'll probably wait to merge until our CI is green again.

@mroeschke mroeschke added this to the 3.0 milestone Jan 29, 2024
@mroeschke mroeschke merged commit 820ad77 into pandas-dev:main Jan 29, 2024
55 of 56 checks passed
@mroeschke
Copy link
Member

Thanks @jordan-d-murphy

@jordan-d-murphy jordan-d-murphy deleted the issue#57111 branch January 30, 2024 03:12
pmhatre1 pushed a commit to pmhatre1/pandas-pmhatre1 that referenced this pull request May 7, 2024
@jordan-d-murphy @pmhatre1
DOC: fix PR02 errors in docstrings - pandas.Series.interpolate, panda…
bb7fc8c 
…s.read_hdf, pandas.HDFStore.append (pandas-dev#57114)

* Resolve PR02 errors in docstrings: pandas.Series.interpolate, pandas.read_hdf, pandas.HDFStore.append

* Update code_checks.sh
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@datapythonista datapythonista datapythonista approved these changes

@mroeschke mroeschke mroeschke approved these changes

Assignees
No one assigned
Labels
Clean Docs
Projects
None yet
Milestone
3.0
Development

Successfully merging this pull request may close these issues.
3 participants
@jordan-d-murphy @mroeschke @datapythonista