Skip to content

DOC: Fix typos in Series.idxmin/idxmax docs #21757

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 1 commit into from
Jul 6, 2018
Merged

DOC: Fix typos in Series.idxmin/idxmax docs #21757

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 5 additions & 5 deletions pandas/core/series.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1657,7 +1657,7 @@ def duplicated(self, keep='first'):
"""
return super(Series, self).duplicated(keep=keep)

def idxmin(self, axis=None, skipna=True, *args, **kwargs):
def idxmin(self, axis=0, skipna=True, *args, **kwargs):
"""
Return the row label of the minimum value.

Expand All @@ -1673,7 +1673,7 @@ def idxmin(self, axis=None, skipna=True, *args, **kwargs):
For compatibility with DataFrame.idxmin. Redundant for application
on Series.
*args, **kwargs
Additional keywors have no effect but might be accepted
Additional keywords have no effect but might be accepted
for compatibility with NumPy.

Returns
Expand Down Expand Up @@ -1742,7 +1742,7 @@ def idxmax(self, axis=0, skipna=True, *args, **kwargs):
For compatibility with DataFrame.idxmax. Redundant for application
on Series.
*args, **kwargs
Additional keywors have no effect but might be accepted
Additional keywords have no effect but might be accepted
for compatibility with NumPy.

Returns
Expand Down Expand Up @@ -1802,14 +1802,14 @@ def idxmax(self, axis=0, skipna=True, *args, **kwargs):
msg=dedent("""\
'argmin' is deprecated, use 'idxmin' instead. The behavior of 'argmin'
will be corrected to return the positional minimum in the future.
Use 'series.values.argmin' to get the position of the minimum now.""")
Use 'series.values.argmin' to get the position of the minimum row.""")
)
argmax = deprecate(
'argmax', idxmax, '0.21.0',
msg=dedent("""\
'argmax' is deprecated, use 'idxmax' instead. The behavior of 'argmax'
will be corrected to return the positional maximum in the future.
Use 'series.values.argmax' to get the position of the maximum now.""")
Use 'series.values.argmax' to get the position of the maximum row.""")
)

def round(self, decimals=0, *args, **kwargs):
Expand Down