8000 Various docstring fixes by ChiefMilesEdgeworth · Pull Request #28744 · pandas-dev/pandas · GitHub
[go: up one dir, main page]
Skip to content

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.

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

Merged
merged 27 commits into from
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 Oct 1, 2019
d1f1ba0
DOC: Fixed other PR02 docstring errors in pandas Series class
ChiefMilesEdgeworth Oct 1, 2019
7fc0e35
DOC: Fixed other PR02 docstring errors in pandas rolling and ewm files
ChiefMilesEdgeworth Oct 2, 2019
cd15cec
DOC: Fixed other PR02 docstring errors in pandas plotting file
ChiefMilesEdgeworth Oct 2, 2019
51bdc5d
DOC: Fixed other PR02 docstring errors in pandas frame.py file
ChiefMilesEdgeworth Oct 2, 2019
ffe849f
Ran Black
ChiefMilesEdgeworth Oct 2, 2019
f3b9540
Flake8 Changes
ChiefMilesEdgeworth Oct 2, 2019
d5c0394
Merge branch 'master' into Various_docstring_fixes
ChiefMilesEdgeworth Oct 2, 2019
bedf748
Test fixes
ChiefMilesEdgeworth Oct 2, 2019
4d7a386
DOC: Test fixes part 2
ChiefMilesEdgeworth Oct 2, 2019
2658caf
Merge branch 'master' into Various_docstring_fixes
ChiefMilesEdgeworth Oct 2, 2019
532b53c
DOC: Update args and kwargs to same line, other small changes
ChiefMilesEdgeworth Oct 3, 2019
2f48f5a
Merge remote-tracking branch 'origin/Various_docstring_fixes' into Va…
ChiefMilesEdgeworth Oct 3, 2019
2df56a2
DOC: Missed whitespace
ChiefMilesEdgeworth Oct 3, 2019
ded2c0c
DOC: Fixing overlooked issues
ChiefMilesEdgeworth Oct 4, 2019
5263577
Merge pull request #1 from pandas-dev/master
ChiefMilesEdgeworth Oct 7, 2019
3b6f88c
Merge remote-tracking branch 'origin/master'
ChiefMilesEdgeworth Oct 8, 2019
894f7d1
Merge remote-tracking branch 'upstream/master'
ChiefMilesEdgeworth Oct 10, 2019
d687909
Merge remote-tracking branch 'upstream/master'
ChiefMilesEdgeworth Oct 11, 2019
ec3b412
Merge branch 'master' into Various_docstring_fixes
ChiefMilesEdgeworth Oct 11, 2019
494b997
DOC: Revert back to multiple parameters on one line
ChiefMilesEdgeworth Oct 15, 2019
2c723a7
Merge remote-tracking branch 'upstream/master' into Various_docstring…
ChiefMilesEdgeworth Oct 15, 2019
0507336
Merge remote-tracking branch 'upstream/master' into Various_docstring…
ChiefMilesEdgeworth Oct 15, 2019
f631cb4
DOC: Spacing fixed
ChiefMilesEdgeworth Oct 16, 2019
16fd88a
DOC: Fixed typos
ChiefMilesEdgeworth Oct 16, 2019
a5cbc8c
Update pandas/core/frame.py
ChiefMilesEdgeworth Nov 8, 2019
2a105c2
Update pandas/core/window/ewm.py
ChiefMilesEdgeworth Nov 8, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
DOC: Fixed other PR02 docstring errors in pandas frame.py file 
Fixed the docstring for transpose, eval, swaplevel, and melt in frame.py
  • Loading branch information
@ChiefMilesEdgeworth
ChiefMilesEdgeworth committed Oct 2, 2019
commit 51bdc5d7eadae2b767ed0440060e02e61677446b
17 changes: 9 additions & 8 deletions pandas/core/frame.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2603,10 +2603,10 @@ def transpose(self, *args, **kwargs):

Parameters
----------
copy : bool, default False
If True, the underlying data is copied. Otherwise (default), no
copy is made if possible.
*args, **kwargs
*args
Additional arguments have no effect but might be accepted for
compatibility with numpy.
**kwargs
Copy link
Member

Choose a reason for hiding this comment

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

The script is wrong in this case, please revert

Additional keywords have no effect but might be accepted for
compatibility with numpy.

Expand Down Expand Up @@ -3230,7 +3230,7 @@ def eval(self, expr, inplace=False, **kwargs):
If the expression contains an assignment, whether to perform the
operation inplace and mutate the existing DataFrame. Otherwise,
a new DataFrame is returned.
kwargs : dict
**kwargs : dict
Copy link
Member

Choose a reason for hiding this comment

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

please remove the type

See the documentation for :func:`eval` for complete details
on the keyword arguments accepted by
:meth:`~pandas.DataFrame.query`.
Expand Down Expand Up @@ -5198,8 +5198,10 @@ def swaplevel(self, i=-2, j=-1, axis=0):

Parameters
----------
i, j : int, str (can be mixed)
Level of index to be swapped. Can pass level name as string.
i : int, str (can be mixed)
Copy link
Member

Choose a reason for hiding this comment

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

int or str, not sure what the can be mixed means here, but shouldn't be in the type (can be explained in the description)

Level of first index to be swapped. Can pass level name as string.
j : int, str (can be mixed)
Level of second index to be swapped. Can pass level name as string.
Copy link
Member

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.

Copy link
Contributor Author

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.

Copy link
Member

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


Returns
-------
Expand Down Expand Up @@ -6295,7 +6297,6 @@ def unstack(self, level=-1, fill_value=None):
%(versionadded)s
Parameters
----------
frame : DataFrame
id_vars : tuple, list, or ndarray, optional
Column(s) to use as identifier variables.
value_vars : tuple, list, or ndarray, optional
Expand Down
0