-
-
Notifications
You must be signed in to change notification settings - Fork 18.7k
Various docstring fixes #28744
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
Merged
WillAyd
merged 27 commits into
pandas-dev:master
from
ChiefMilesEdgeworth:Various_docstring_fixes
Nov 8, 2019
Merged
Various docstring fixes #28744
Changes from 1 commit
Commits
Show all changes
27 commits
Select commit
Hold shift + click to select a range
a3e4315
DOC: Fixed PR02 docstring error in pandas Series idxmin and idxmax
ChiefMilesEdgeworth d1f1ba0
DOC: Fixed other PR02 docstring errors in pandas Series class
ChiefMilesEdgeworth 7fc0e35
DOC: Fixed other PR02 docstring errors in pandas rolling and ewm files
ChiefMilesEdgeworth cd15cec
DOC: Fixed other PR02 docstring errors in pandas plotting file
ChiefMilesEdgeworth 51bdc5d
DOC: Fixed other PR02 docstring errors in pandas frame.py file
ChiefMilesEdgeworth ffe849f
Ran Black
ChiefMilesEdgeworth f3b9540
Flake8 Changes
ChiefMilesEdgeworth d5c0394
Merge branch 'master' into Various_docstring_fixes
ChiefMilesEdgeworth bedf748
Test fixes
ChiefMilesEdgeworth 4d7a386
DOC: Test fixes part 2
ChiefMilesEdgeworth 2658caf
Merge branch 'master' into Various_docstring_fixes
ChiefMilesEdgeworth 532b53c
DOC: Update args and kwargs to same line, other small changes
ChiefMilesEdgeworth 2f48f5a
Merge remote-tracking branch 'origin/Various_docstring_fixes' into Va…
ChiefMilesEdgeworth 2df56a2
DOC: Missed whitespace
ChiefMilesEdgeworth ded2c0c
DOC: Fixing overlooked issues
ChiefMilesEdgeworth 5263577
Merge pull request #1 from pandas-dev/master
ChiefMilesEdgeworth 3b6f88c
Merge remote-tracking branch 'origin/master'
ChiefMilesEdgeworth 894f7d1
Merge remote-tracking branch 'upstream/master'
ChiefMilesEdgeworth d687909
Merge remote-tracking branch 'upstream/master'
ChiefMilesEdgeworth ec3b412
Merge branch 'master' into Various_docstring_fixes
ChiefMilesEdgeworth 494b997
DOC: Revert back to multiple parameters on one line
ChiefMilesEdgeworth 2c723a7
Merge remote-tracking branch 'upstream/master' into Various_docstring…
ChiefMilesEdgeworth 0507336
Merge remote-tracking branch 'upstream/master' into Various_docstring…
ChiefMilesEdgeworth f631cb4
DOC: Spacing fixed
ChiefMilesEdgeworth 16fd88a
DOC: Fixed typos
ChiefMilesEdgeworth a5cbc8c
Update pandas/core/frame.py
ChiefMilesEdgeworth 2a105c2
Update pandas/core/window/ewm.py
ChiefMilesEdgeworth File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
DOC: Update args and kwargs to same line, other small changes
Put args and kwargs back on the same line, since that's how the documentation should be. The validation script needs to be changed to catch this.
- Loading branch information
commit 532b53cc800b571fe275a9b4e1d371d021e43e31
There are no files selected for viewing
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
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
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 edito
8000
r that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -398,7 +398,8 @@ def lag_plot(series, lag=1, ax=None, **kwds): | |
series : Time series | ||
lag : lag of the scatter plot, default 1 | ||
ax : Matplotlib axis object, optional | ||
**kwds : Matplotlib scatter method keyword arguments, optional | ||
**kwds | ||
Matplotlib scatter method keyword arguments, optional | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Can you remove the optional, and end with period. |
||
|
||
Returns | ||
------- | ||
|
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd merge those, I think the validation script should accept this, as proposed in the PR where you update it.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Right now the proposed script does not validate any variables on the same line, just *args and **kwargs. I left it that way in case we decide we don't want people to just throw a bunch of variables on the same line. If you think that'd be fine, then I can rewrite the script update to allow for that, and change these here.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think the PR allowing having those together was merged, right? Can you have
i, j
instead please