DOC: Standardize noncompliant docstrings in pandas/io/html.py (flake8-docstrings) #61944 #62007
+46
−13
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
arthurlw
reviewed
Jul 31, 2025
| search for attributes when using the lxml parser. | ||
| Build an XPath expression to simulate bs4's ability to pass in kwargs. | ||
|
|
||
| Search for attributes when using the lxml parser. |
There was a problem hiding this comment.
Which violations does this change fix? cwiw, original and updated versions appear functionally equivalent
There was a problem hiding this comment.
Thanks for the review, @arthurlw!
The changes in this PR resolve flake8-docstrings violations documented in #61944. Specifically:
- _build_xpath_expr: addresses D205 (missing blank line after summary) and D400 (summary should end with a period)
- _build_doc: resolves D205, D400, and D401 (summary should be in imperative mood)
- _equals_tag and _handle_hidden_tables: fixed D400
These are pure docstring updates — no logic or behavior changes. I validated using pydocstyle and flake8-docstrings with the project's config. Happy to clarify or expand if anything seems inconsistent!
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
…-docstrings) #61944
This PR addresses docstring violations identified in #61944.
Changes made:
_build_xpath_expr: fixed D205 and D400_build_doc: fixed D205, D400, and D401_equals_tagand_handle_hidden_tables: fixed D400pydocstyleandflake8-docstringsNotes:
Scope limited to validated violations from the issue
_remove_whitespacewas not flagged in my environment (may be config-dependent)Let me know if you'd like additional functions standardized for consistency
[ x] closes DOC: Standardize noncompliant docstrings in pandas/io/html.py (flake8-docstrings) #61944
Tests added and passed if fixing a bug or adding a new feature
[x ] All code checks passed.
Added type annotations to new arguments/methods/functions.
Added an entry in the latest
doc/source/whatsnew/vX.X.X.rstfile if fixing a bug or adding a new feature.