Skip to content

DOC: fix EX03 errors in docstrings - pandas.Series.to_latex, pandas.read_pickle, pandas.DataFrame.to_latex, pandas.core.resample.Resampler.pipe #56843

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 12 commits into from
Jan 14, 2024

Conversation

jordan-d-murphy
Copy link
Contributor

@jordan-d-murphy jordan-d-murphy commented Jan 12, 2024

Checked if validation docstrings passes for :

  1. scripts/validate_docstrings.py --format=actions --errors=EX03 pandas.Series.to_latex
  2. scripts/validate_docstrings.py --format=actions --errors=EX03 pandas.read_pickle
  3. scripts/validate_docstrings.py --format=actions --errors=EX03 pandas.DataFrame.to_latex
  4. scripts/validate_docstrings.py --format=actions --errors=EX03 pandas.core.resample.Resampler.pipe

OUTPUT:

  1. scripts/validate_docstrings.py --format=actions --errors=EX03 pandas.Series.to_latex
################################################################################
################################## Validation ##################################
################################################################################

Docstring for "pandas.Series.to_latex" correct. :)
  1. scripts/validate_docstrings.py --format=actions --errors=EX03 pandas.read_pickle
################################################################################
################################## Validation ##################################
################################################################################

Docstring for "pandas.read_pickle" correct. :)
  1. scripts/validate_docstrings.py --format=actions --errors=EX03 pandas.DataFrame.to_latex
################################################################################
################################## Validation ##################################
################################################################################

Docstring for "pandas.DataFrame.to_latex" correct. :)
  1. scripts/validate_docstrings.py --format=actions --errors=EX03 pandas.core.resample.Resampler.pipe
################################################################################
################################## Validation ##################################
################################################################################

Docstring for "pandas.core.resample.Resampler.pipe" correct. :)

@jordan-d-murphy
Copy link
Contributor Author

jordan-d-murphy commented Jan 12, 2024

Looks like the check for macos-latest actions-312.yaml is failing, I cannot seem to find a way to re run the check. Any guidance would be appreciated.

EDIT:
I was able to re-run from my local machine but the "Checkout" phase of macos-latest actions-312.yaml is still failing with "Error: fatal: unable to access 'https://github.com/pandas-dev/pandas/': Could not resolve host: github.com"

FINAL EDIT:
Merging main branch back into my branch resolved this issue and after running the checks again, All checks have passed.

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.

Thank you @jordan-d-murphy, very nice. I added couple of comments that I think will make the documentation clearer for users, but great changes, thanks for fixing this.

@jordan-d-murphy
Copy link
Contributor Author

@datapythonista I've responded to your comments and updated my code. Can you please review again when you have a moment? Thanks for all the detailed feedback. If any improvements are still needed I'm happy to revisit any issues that you find.

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 good to me, maybe you want to incorporate the suggestion in my last comment, but looks good regardless. Thanks for the work on this, looks great.

@datapythonista datapythonista merged commit 8bd4e0b into pandas-dev:main Jan 14, 2024
@datapythonista
Copy link
Member

Thanks @jordan-d-murphy, great work

@jordan-d-murphy jordan-d-murphy deleted the issue#56804_4 branch January 15, 2024 23:18
pmhatre1 pushed a commit to pmhatre1/pandas-pmhatre1 that referenced this pull request May 7, 2024
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