Skip to content

DOC: fix PR02 errors in docstring for pandas.core.groupby.DataFrameGroupBy.corrwith #57243

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
Merged
merged 6 commits into from
Feb 6, 2024
Merged

DOC: fix PR02 errors in docstring for pandas.core.groupby.DataFrameGroupBy.corrwith #57243

merged 6 commits into from
Feb 6, 2024
+59 −5

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.core.groupby.DataFrameGroupBy.corrwith
  2. scripts/validate_docstrings.py --format=actions --errors=PR02 pandas.DataFrame.corrwith

OUTPUT:

  1. scripts/validate_docstrings.py --format=actions --errors=PR02 pandas.core.groupby.DataFrameGroupBy.corrwith
################################################################################
################################## Validation ##################################
################################################################################

Docstring for "pandas.core.groupby.DataFrameGroupBy.corrwith" correct. :)
  1. scripts/validate_docstrings.py --format=actions --errors=PR02 pandas.DataFrame.corrwith
################################################################################
################################## Validation ##################################
################################################################################

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

rhshadrach
rhshadrach requested changes Feb 4, 2024
View reviewed changes
Copy link
Member

@rhshadrach rhshadrach left a comment

Choose a reason for hiding this comment

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

Thanks for the PR. Just in case you aren't aware, the validation runs on the CI, so you don't need to show the result of OUTPUT: if you don't want to - we'll see it if it fails 😄.

rhshadrach
rhshadrach approved these changes Feb 6, 2024
View reviewed changes
Copy link
Member

@rhshadrach rhshadrach left a comment

Choose a reason for hiding this comment

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

lgtm

@jordan-d-murphy
Copy link
Contributor Author

@mroeschke can you take a look at this PR when you get a chance?

@mroeschke mroeschke added this to the 3.0 milestone Feb 6, 2024
@mroeschke mroeschke merged commit 6725e37 into pandas-dev:main Feb 6, 2024
@mroeschke
Copy link
Member

Thanks keep em coming!

@jordan-d-murphy jordan-d-murphy deleted the issue#57111_7 branch February 7, 2024 01:31
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 docstring for pandas.core.groupby.DataFrameGr…
4a7aee1 
…oupBy.corrwith (pandas-dev#57243)

* DOC: fix PR02 errors in docstring for pandas.core.groupby.DataFrameGroupBy.corrwith

* updated code example for groupby(...).corrwith
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

@rhshadrach rhshadrach rhshadrach approved these changes

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

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