Skip to content

DOC: Fixing GL08 errors for pandas.ExcelFile.sheet_names and pandas.MultiIndex.codes #57601

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 11 commits into from
Feb 27, 2024
Merged

DOC: Fixing GL08 errors for pandas.ExcelFile.sheet_names and pandas.MultiIndex.codes #57601

merged 11 commits into from
Feb 27, 2024

Conversation

@thomasdamcevski
Copy link
Contributor

@thomasdamcevski thomasdamcevski commented Feb 24, 2024

Resolved GL08 errors for the following:

  1. scripts/validate_docstrings.py --format=actions --errors=GL08 pandas.ExcelFile.sheet_names
  2. scripts/validate_docstrings.py --format=actions --errors=GL08 pandas.MultiIndex.codes

Ref: #57443

  • closes #xxxx (Replace xxxx with the GitHub issue number)
  • Tests added and passed if fixing a bug or adding a new feature
  • All code checks passed.
  • Added type annotations to new arguments/methods/functions.
  • Added an entry in the latest doc/source/whatsnew/vX.X.X.rst file if fixing a bug or adding a new feature.
bergnerjonas
bergnerjonas reviewed Feb 24, 2024
View reviewed changes
bergnerjonas
bergnerjonas reviewed Feb 24, 2024
View reviewed changes
thomasdamcevski and others added 2 commits February 25, 2024 11:13
@thomasdamcevski @bergnerjonas
Update sheet_names docstring
fa06444 
Co-authored-by: Jonas Bergner <44500888+bergnerjonas@users.noreply.github.com>
@thomasdamcevski @bergnerjonas
Update MultiIndex.codes docstring to be less awkward
b1c153c 
Co-authored-by: Jonas Bergner <44500888+bergnerjonas@users.noreply.github.com>
rhshadrach
rhshadrach requested changes Feb 25, 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! I think this is looking good, some suggestions.
rhshadrach
rhshadrach approved these changes Feb 27, 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
@rhshadrach rhshadrach added this to the 3.0 milestone Feb 27, 2024
@rhshadrach rhshadrach added Docs CI Continuous Integration IO Excel read_excel, to_excel MultiIndex labels Feb 27, 2024
@rhshadrach rhshadrach merged commit 7a2e96c into pandas-dev:main Feb 27, 2024
@rhshadrach
Copy link
Member

rhshadrach commented Feb 27, 2024

Thanks @thomasdamcevski and @bergnerjonas
@thomasdamcevski thomasdamcevski deleted the GL08-fixes branch February 28, 2024 03:45
@sam-baumann sam-baumann mentioned this pull request Apr 24, 2024
Closed
pmhatre1 pushed a commit to pmhatre1/pandas-pmhatre1 that referenced this pull request May 7, 2024
@thomasdamcevski @bergnerjonas @pmhatre1
DOC: Fixing GL08 errors for pandas.ExcelFile.sheet_names and pandas.M…
f40172e 
…ultiIndex.codes (pandas-dev#57601) Co-authored-by: Jonas Bergner <44500888+bergnerjonas@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CI Continuous Integration Docs IO Excel read_excel, to_excel MultiIndex

3 participants

@thomasdamcevski @rhshadrach @bergnerjonas