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.

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

DOC: Fixing EX01 - Added example #54126

Merged
merged 12 commits into from
Jul 18, 2023
Merged

Conversation

DeaMariaLeon
Copy link
Member

@DeaMariaLeon DeaMariaLeon commented Jul 14, 2023

Towards #37875

Modified validate_docstrings.py: it was raising for "importing pandas". If I didn't import pandas_gbq on the docstring, the error was for undeclared name.

Not sure if I have to add a test for that case or if the fix is good enough.

@DeaMariaLeon DeaMariaLeon added this to the 2.1 milestone Jul 14, 2023
pandas/core/frame.py Outdated Show resolved Hide resolved
pandas/core/frame.py Outdated Show resolved Hide resolved
@DeaMariaLeon DeaMariaLeon changed the title DOC: Fixing EX01 - Added example and modified validate_docstrings.py DOC: Fixing EX01 - Added example Jul 14, 2023
pandas/core/frame.py Outdated Show resolved Hide resolved
@mroeschke
Copy link
Member

Looks good. Could you merge main once more?

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.

thanks @DeaMariaLeon !

Comment on lines 2113 to 2114
>>> project_id = "my-project" # doctest: +SKIP
>>> table_id = 'my_dataset.my_table' # doctest: +SKIP
Copy link
Member

Choose a reason for hiding this comment

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

do these need skipping because otherwise flake8 complains they're unused?

Copy link
Member Author

Choose a reason for hiding this comment

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

Good question, the skipping was not needed. I removed them.
flake8 complained earlier when the variables were not declared, but it was not related to the doctest skip.

@DeaMariaLeon
Copy link
Member Author

It looks green if someone very kind wants to merge, it would be great.

@mroeschke mroeschke merged commit 8e403e4 into pandas-dev:main Jul 18, 2023
32 checks passed
@mroeschke
Copy link
Member

Thanks @DeaMariaLeon

@DeaMariaLeon DeaMariaLeon deleted the Jul14-2 branch July 18, 2023 16:48
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