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 EX03 errors in docstrings - pandas.Series.plot.line, pandas.Series.to_sql, pandas.read_json, pandas.DataFrame.to_sql #57025

Merged
merged 3 commits into from
Jan 23, 2024
Merged

DOC: fix EX03 errors in docstrings - pandas.Series.plot.line, pandas.Series.to_sql, pandas.read_json, pandas.DataFrame.to_sql #57025

merged 3 commits into from
Jan 23, 2024

Conversation

jordan-d-murphy
Copy link
Contributor

@jordan-d-murphy jordan-d-murphy commented Jan 23, 2024 •
edited
Loading

All EX03 Errors resolved in the following cases:

  1. scripts/validate_docstrings.py --format=actions --errors=EX03 pandas.Series.plot.line
  2. scripts/validate_docstrings.py --format=actions --errors=EX03 pandas.Series.to_sql
  3. scripts/validate_docstrings.py --format=actions --errors=EX03 pandas.read_json
  4. scripts/validate_docstrings.py --format=actions --errors=EX03 pandas.DataFrame.to_sql

OUTPUT:

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

1 Errors found for `pandas.Series.plot.line`:
	PR02	Unknown parameters {'color'}
  1. scripts/validate_docstrings.py --format=actions --errors=EX03 pandas.Series.to_sql
################################################################################
################################## Validation ##################################
################################################################################

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

1 Errors found for `pandas.read_json`:
	ES01	No extended summary found
  1. scripts/validate_docstrings.py --format=actions --errors=EX03 pandas.DataFrame.to_sql
################################################################################
################################## Validation ##################################
################################################################################

Docstring for "pandas.DataFrame.to_sql" correct. :)

@jordan-d-murphy
DOC: fix EX03 errors in docstrings - pandas.Series.plot.line, pandas.…
c1ce139 
…Series.to_sql, pandas.read_json, pandas.DataFrame.to_sql
datapythonista
datapythonista reviewed Jan 23, 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.

I think this will close #56866 and #56865 which seem to be stale. Can you have a look and ping me on these PRs once this is merged so I can close them? Thanks!

ci/code_checks.sh Outdated Show resolved Hide resolved
@jordan-d-murphy
Copy link
Contributor Author

@datapythonista you are correct, this will close stale PRs #56866 and #56865

I'll ping you when this PR is merged into main

datapythonista
datapythonista approved these changes Jan 23, 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.

Thanks @jordan-d-murphy, looks great.

@mroeschke mroeschke added this to the 3.0 milestone Jan 23, 2024
@mroeschke mroeschke merged commit 576ba28 into pandas-dev:main Jan 23, 2024
49 of 50 checks passed
@mroeschke
Copy link
Member

Thanks for all your effort here @jordan-d-murphy

This was referenced Jan 23, 2024
Closed
Closed
@jordan-d-murphy jordan-d-murphy deleted the issue#56804_13 branch January 23, 2024 18:20
@jordan-d-murphy jordan-d-murphy mentioned this pull request Jan 23, 2024
Closed
pmhatre1 pushed a commit to pmhatre1/pandas-pmhatre1 that referenced this pull request May 7, 2024
@jordan-d-murphy @pmhatre1
DOC: fix EX03 errors in docstrings - pandas.Series.plot.line, pandas.…
aaac9b8 
…Series.to_sql, pandas.read_json, pandas.DataFrame.to_sql (pandas-dev#57025)

* DOC: fix EX03 errors in docstrings - pandas.Series.plot.line, pandas.Series.to_sql, pandas.read_json, pandas.DataFrame.to_sql

* removed EX03 specific block, and added EX03 to "Validate docstrings" block
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mroeschke mroeschke mroeschke approved these changes

@datapythonista datapythonista datapythonista approved these changes

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

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