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 docstring for pandas.Series.rename_axis #57239

Merged
merged 5 commits into from
Feb 4, 2024
Merged

DOC: fix PR02 errors in docstring for pandas.Series.rename_axis #57239

merged 5 commits into from
Feb 4, 2024

Conversation

jordan-d-murphy
Copy link
Contributor

@jordan-d-murphy jordan-d-murphy commented Feb 4, 2024 •
edited
Loading

All PR02 Errors resolved in the following cases:

  1. scripts/validate_docstrings.py --format=actions --errors=PR02 pandas.Series.rename_axis
  2. scripts/validate_docstrings.py --format=actions --errors=PR02 pandas.DataFrame.rename_axis

OUTPUT:

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

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

1 Errors found for `pandas.DataFrame.rename_axis`:
	ES01	No extended summary found

mroeschke
mroeschke reviewed Feb 4, 2024
View reviewed changes
pandas/core/generic.py Outdated Show resolved Hide resolved
@mroeschke mroeschke added the Docs label Feb 4, 2024
@jordan-d-murphy
Copy link
Contributor Author

@mroeschke I've pushed a fix for your suggested improvements, can you take another look?

@mroeschke mroeschke added this to the 3.0 milestone Feb 4, 2024
@mroeschke mroeschke merged commit 266bd4c into pandas-dev:main Feb 4, 2024
46 of 47 checks passed
@mroeschke
Copy link
Member

Thanks @jordan-d-murphy

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.Series.rename_axis (pand…
d7fdeff 
…as-dev#57239)

* DOC: fix PR02 errors in docstring for pandas.Series.rename_axis

* Refactor Series.rename_axis and NDFrame.rename_axis to have separate docstrings

* removed unnecessary columns ref in docstring for Series

* removed another unnecessary columns ref in docstring for Series
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

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

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