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: added docstring for storage_options in read_html #54815

Merged
merged 4 commits into from
Aug 29, 2023
Merged

DOC: added docstring for storage_options in read_html #54815

merged 4 commits into from
Aug 29, 2023

Conversation

rsm-23
Copy link
Contributor

@rsm-23 rsm-23 commented Aug 28, 2023 •
edited
Loading

@rsm-23
Copy link
Contributor Author

rsm-23 commented Aug 28, 2023 •
edited
Loading

@mroeschke docstring validation failing with

Redefining name from outer scope.........................................Failed

  • hook id: pylint
  • duration: 45.12s
  • exit code: 4

************* Module pandas.io.html
pandas/io/html.py:368:28: W0621: Redefining name 'doc' from outer scope (line 26) (redefined-outer-name)
pandas/io/html.py:599:28: W0621: Redefining name 'doc' from outer scope (line 26) (redefined-outer-name)
pandas/io/html.py:731:28: W0621: Redefining name 'doc' from outer scope (line 26) (redefined-outer-name)

one such function which shares the same name as the decorator is this:
def _parse_tables(self, doc, match, attrs):

Any suggestions? should I rename the parameter name?

@mroeschke
Copy link
Member

should I rename the parameter name?

Yes this sounds reasonable

@mroeschke mroeschke added the Docs label Aug 28, 2023
@rsm-23
Copy link
Contributor Author

rsm-23 commented Aug 29, 2023

@mroeschke can you please review this PR?

@mroeschke mroeschke added this to the 2.1 milestone Aug 29, 2023
@mroeschke mroeschke merged commit a478e21 into pandas-dev:main Aug 29, 2023
@mroeschke
Copy link
Member

Thanks @rsm-23

@meeseeksmachine meeseeksmachine mentioned this pull request Aug 29, 2023
Merged
meeseeksmachine pushed a commit to meeseeksmachine/pandas that referenced this pull request Aug 29, 2023
@rsm-23 @meeseeksmachine
Backport PR pandas-dev#54815: DOC: added docstring for `storage_optio…
ece5ad2 
…ns` in `read_html`
phofl pushed a commit that referenced this pull request Aug 29, 2023
@meeseeksmachine @rsm-23
Backport PR #54815 on branch 2.1.x (DOC: added docstring for `storage…
f7f2057 
…_options` in `read_html`) (#54852)

Backport PR #54815: DOC: added docstring for `storage_options` in `read_html`

Co-authored-by: Rajat Subhra Mukherjee <raromukherjee@gmail.com>
mroeschke pushed a commit to mroeschke/pandas that referenced this pull request Sep 11, 2023
@rsm-23 @mroeschke
DOC: added docstring for storage_options in read_html (pandas-dev…
79bca17 
…#54815)

* added docstring for storage_options

* renamed parameter name for _parse_tables
@code-narrator code-narrator mentioned this pull request Sep 26, 2023
Closed
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
2.1
Development

Successfully merging this pull request may close these issues.

DOCS: the storage_options parameter is not included in the read_html docstring
2 participants
@rsm-23 @mroeschke