Skip to content

DOC: fix EX02 errors in docstrings #51529

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 1 commit into from
Feb 21, 2023
Merged

DOC: fix EX02 errors in docstrings #51529

merged 1 commit into from
Feb 21, 2023

Conversation

natmokval
Copy link
Contributor

Related to the issue #51236

This PR enables functions:
pandas.io.formats.style.Styler.concat
pandas.io.formats.style.Styler.export
pandas.io.formats.style.Styler.set_td_classes
pandas.io.formats.style.Styler.use

MarcoGorelli
MarcoGorelli reviewed Feb 21, 2023
View reviewed changes
pandas/io/formats/style.py
Comment on lines +362 to +363
>>> df = pd.DataFrame([[1], [2]],
... index=pd.MultiIndex.from_product([[0], [1, 2]]))
Copy link
Member

Choose a reason for hiding this comment

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

the indentation looks a bit odd here, if you just run validate_docstrings on just this function, I think you might get an EX03 error about that? If so, could you better align it please? I think something like

        >>> df = pd.DataFrame([[1], [2]],
        ...                   index=pd.MultiIndex.from_product([[0], [1, 2]]))

should do

@mroeschke mroeschke added the Docs label Feb 21, 2023
@MarcoGorelli MarcoGorelli added this to the 2.1 milestone Feb 21, 2023
MarcoGorelli
MarcoGorelli approved these changes Feb 21, 2023
View reviewed changes
Copy link
Member

@MarcoGorelli MarcoGorelli left a comment

Choose a reason for hiding this comment

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

Actually, let's just take this - we'll fix EX03 errors when we fix EX03 errors

Thanks @natmokval !

@MarcoGorelli MarcoGorelli merged commit 3e2ec50 into pandas-dev:main Feb 21, 2023
@natmokval
Copy link
Contributor Author

Actually, let's just take this - we'll fix EX03 errors when we fix EX03 errors

I just created the change for the indentation issue.

And while running python scripts/validate_docstrings.py pandas.io.formats.style.Styler.concat
the missing whitespace error appeared in 3 other examples for concat, I corrected it as well.

Should I create a new PR for this?

@MarcoGorelli
Copy link
Member

sure, thanks! or just include them in the next PR

@natmokval natmokval mentioned this pull request Feb 23, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@MarcoGorelli MarcoGorelli MarcoGorelli approved these changes

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

Successfully merging this pull request may close these issues.
3 participants
@natmokval @MarcoGorelli @mroeschke