Skip to content

DOC: add mention of idx* methods in max/min methods of Series/DataFrame #3580

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
merged 2 commits into from
May 13, 2013
Merged

DOC: add mention of idx* methods in max/min methods of Series/DataFrame #3580

merged 2 commits into from
May 13, 2013

Conversation

cpcloud
Copy link
Member

@cpcloud cpcloud commented May 11, 2013

closes #3574.

"""
Notes
-----
The ``numpy.ndarray`` method ``argmin`` is called ``idxmin`` in
Copy link
Contributor

Choose a reason for hiding this comment

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

are these in the right place? min/max are the arithmetic methods

Copy link
Member Author

Choose a reason for hiding this comment

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

The request from the issue was that they are mentioned in the min/max methods since ndarray's methods are argmin/argmax. Can change if u want.

Copy link
Contributor

Choose a reason for hiding this comment

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

ok that's reasonable
maybe put I that his method returns the min of the values
but if u want the index of the min then use idxmin.

@jreback
Copy link
Contributor

jreback commented May 13, 2013

do you maybe also want to put a mention in the main docs as well (I think then you can search on say: argmax) and the docs will come up for idxmin....not 100% sure about this though

@cpcloud
Copy link
Member Author

cpcloud commented May 13, 2013

added to basics.rst.

jreback added a commit that referenced this pull request May 13, 2013
DOC: add mention of idx* methods in max/min methods of Series/DataFrame
@jreback jreback merged commit 293b16d into pandas-dev:master May 13, 2013
@cpcloud cpcloud deleted the argminmax-doc-3574 branch May 22, 2013 02:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

DOC: docstring for min max should point out idxmax and idxmin
2 participants