STYLE improve validate-docstrings ergonomics
#52482
Merged
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
MarcoGorelli
commented
Apr 6, 2023
| @@ -1005,11 +1005,11 @@ class Window(BaseWindow): | |||
| Rolling sum with a window span of 2 seconds. | |||
|
|
|||
| >>> df_time = pd.DataFrame({'B': [0, 1, 2, np.nan, 4]}, | |||
| ... index = [pd.Timestamp('20130101 09:00:00'), | |||
There was a problem hiding this comment.
couldn't resist fixing up a docstring with these improved ergonomics
MarcoGorelli
commented
Apr 6, 2023
Comment on lines
+8
to
+9
| # expected n blank lines | ||
| E3, |
There was a problem hiding this comment.
E3 shows things like "expected 2 blank lines, expected 0" which I think is a bit irrelevant for docstrings - we put the lines one after the other anyway, having empty >>> lines in docstrings wouldn't look good
datapythonista
approved these changes
Apr 6, 2023
mroeschke
approved these changes
Apr 6, 2023
|
Thanks @MarcoGorelli |
topper-123
pushed a commit
to topper-123/pandas
that referenced
this pull request
Apr 6, 2023
improve `validate-docstrings` ergonomics Co-authored-by: MarcoGorelli <>
|
Arrived late to the party |
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.
Before opening an issue for EX03 errors, I just wanted to improve the usability of
validate_docstringsCurrently it's kind of hard to tell which lines need to change, especially if there's a long docstring.
Now, here's what it shows for
python scripts/validate_docstrings.py pandas.Series.describe:From trying it out locally, this makes it much easier to tell what needs changing