Skip to content

Question regarding Series.argsort documentation #24816

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

Closed
dsaxton opened this issue Jan 17, 2019 · 3 comments · Fixed by #24830
Closed

Question regarding Series.argsort documentation #24816

dsaxton opened this issue Jan 17, 2019 · 3 comments · Fixed by #24830

Comments

@dsaxton
Copy link
Member

dsaxton commented Jan 17, 2019

Series.argsort has three arguments, axis, kind and order, but only kind is actually used. Should the other two be removed from the documentation? (I'm guessing they were once used and are left in the code for compatibility reasons?)

https://pandas.pydata.org/pandas-docs/stable/generated/pandas.Series.argsort.html

@TomAugspurger
Copy link
Contributor

TomAugspurger commented Jan 17, 2019 via email

@jschendel
Copy link
Member

I believe axis and order are needed to match the signature of np.argsort

Could probably update the documentation similar to Series.repeat in that case to make it more explicit that it has no effect but is accepted for compatibility with numpy.

@jschendel jschendel added this to the Contributions Welcome milestone Jan 17, 2019
@benjaminr
Copy link
Contributor

Happy to look at updating the documentation to reflect his.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants