Skip to content

DOC: fixed Ex03 errors in docstrings: #56878

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

Conversation

tiffanyxiao
Copy link
Contributor

PR SUMMARY

Checked if validation docstrings passes for:

  • pandas.errors.DatabaseError
  • pandas.errors.IndexingError
  • pandas.errors.InvalidColumnName

OUTPUT:

  1. python scripts/validate_docstrings.py --format=actions --errors=EX03 pandas.errors.DatabaseError
################################################################################
################################## Validation ##################################
################################################################################

Docstring for "pandas.errors.DatabaseError" correct. :)
  1. python scripts/validate_docstrings.py --format=actions --errors=EX03 pandas.errors.IndexingError
################################################################################
################################## Validation ##################################
################################################################################

Docstring for "pandas.errors.IndexingError" correct. :)
  1. python scripts/validate_docstrings.py --format=actions --errors=EX03 pandas.errors.InvalidColumnName
################################################################################
################################## Validation ##################################
################################################################################

Docstring for "pandas.errors.InvalidColumnName" correct. :)

PR CHECKLIST

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 @tiffanyxiao, great job. Just one comment, as I think you can simplify the formatting in the see also section.

Also, there seems to be a conflict after merging another PR. Can you merge main into your PR and resolve the conflict please?


See Also
--------
:attr:`.pandas.DataFrame.iloc` : Purely integer-location based indexing for \
Copy link
Member

Choose a reason for hiding this comment

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

I don't think in the See Also section we need those :attr: markers, I think just DataFrame.iloc should render correctly. Same for the other cases in this PR.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Hi Marc,

Thanks! I pushed these changes up.

@mroeschke mroeschke added this to the 3.0 milestone Jan 15, 2024
@mroeschke mroeschke merged commit f14893d into pandas-dev:main Jan 15, 2024
@mroeschke
Copy link
Member

Thanks @tiffanyxiao

pmhatre1 pushed a commit to pmhatre1/pandas-pmhatre1 that referenced this pull request May 7, 2024
* Addressing docstring errors

* Resolving merge conflicts

* Removing extra formatting in See Also
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.

3 participants