Skip to content

DOC: Out-of-date list of sort algorithms #38287

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

Jump to bottom
Closed
jamesmyatt opened this issue Dec 4, 2020 · 3 comments · Fixed by #38503
Closed

DOC: Out-of-date list of sort algorithms #38287

jamesmyatt opened this issue Dec 4, 2020 · 3 comments · Fixed by #38503
Labels
Algos Non-arithmetic algos: value_counts, factorize, sorting, isin, clip, shift, diff Docs
Milestone
1.3

Comments

@jamesmyatt
Copy link
Contributor

jamesmyatt commented Dec 4, 2020 •
edited
Loading

Location of the documentation

e.g. https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.Series.sort_values.html, https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.DataFrame.sort_index.html

Documentation problem

List of values for kind should be updated to reflect changes in NumPy: https://numpy.org/doc/stable/reference/generated/numpy.sort.html

Specifically, since NumPy 1.15.0, the list has been {‘quicksort’, ‘mergesort’, ‘heapsort’, ‘stable’}

Suggested fix for documentation

Full list of options is provided. Also, the statement that "‘mergesort’ is the only stable algorithm" is now incorrect.

I can do this, when I get time. But I'm more than happy for someone else to do it if they want.
@jamesmyatt jamesmyatt added Docs Needs Triage Issue that has not been reviewed by a pandas team member labels Dec 4, 2020
@rhshadrach
Copy link
Member

Thanks for the report! PR to update is most welcome.

@rhshadrach rhshadrach added Algos Non-arithmetic algos: value_counts, factorize, sorting, isin, clip, shift, diff and removed Needs Triage Issue that has not been reviewed by a pandas team member labels Dec 6, 2020
@rhshadrach rhshadrach added this to the Contributions Welcome milestone Dec 6, 2020
@FullBeardDev
Copy link
Contributor

@jamesmyatt are you ok with me taking this ?

FullBeardDev pushed a commit to FullBeardDev/pandas that referenced this issue Dec 15, 2020
DOC: Corrected Out-of-date list of sort algorithms
3f4d172 
Reference Issues/PRs
Fixes: pandas-dev#38287

Implemented changes:
Changed the docstring of all the methods using np.sort as it now includes one additional stable algorithm
@FullBeardDev FullBeardDev mentioned this issue Dec 15, 2020
Merged
@jreback jreback modified the milestones: Contributions Welcome, 1.3 Dec 16, 2020
FullBeardDev pushed a commit to FullBeardDev/pandas that referenced this issue Dec 16, 2020
DOC: Corrected Out-of-date list of sort algorithms
c87a3ee 
Reference Issues/PRs
Fixes: pandas-dev#38287

Implemented changes:
Changed the docstring of all the methods using np.sort as it now includes one additional stable algorithm
@jamesmyatt
Copy link
Contributor Author

@DonPablo99 Of course. Thank you.

FullBeardDev pushed a commit to FullBeardDev/pandas that referenced this issue Dec 17, 2020
DOC: Corrected Out-of-date list of sort algorithms
a75b843 
Reference Issues/PRs
Fixes: pandas-dev#38287

Implemented changes:
Changed the docstring of all the methods using np.sort as it now includes one additional stable algorithm
FullBeardDev pushed a commit to FullBeardDev/pandas that referenced this issue Dec 29, 2020
DOC: Corrected Out-of-date list of sort algorithms
4e01bcf 
Reference Issues/PRs
Fixes: pandas-dev#38287

Implemented changes:
Changed the docstring of all the methods using np.sort as it now includes one additional stable algorithm
FullBeardDev pushed a commit to FullBeardDev/pandas that referenced this issue Dec 30, 2020
DOC: Corrected Out-of-date list of sort algorithms
9bea1cc 
Reference Issues/PRs
Fixes: pandas-dev#38287

Implemented changes:
Changed the docstring of all the methods using np.sort as it now includes one additional stable algorithm
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Algos Non-arithmetic algos: value_counts, factorize, sorting, isin, clip, shift, diff Docs
Projects
None yet
Milestone
1.3
Development

Successfully merging a pull request may close this issue.

DOC: Corrected Out-of-date list of sort algorithms FullBeardDev/pandas
4 participants
@jreback @jamesmyatt @FullBeardDev @rhshadrach