Update the (partial)sortperm docs #27169
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
kmsquire
approved these changes
May 20, 2018
nalimilan
reviewed
May 21, 2018
| @@ -685,16 +685,35 @@ sort(v::AbstractVector; kws...) = sort!(copymutable(v); kws...) | |||
| ## partialsortperm: the permutation to sort the first k elements of an array ## | |||
|
|
|||
| """ | |||
| partialsortperm(v, k; alg=<algorithm>, by=<transform>, lt=<comparison>, rev=false) | |||
| partialsortperm(v, k; by=<transform>, lt=<comparison>, rev=false) | |||
There was a problem hiding this comment.
Could also remove the alg argument from the partialsortperm! docstring.
|
This seems good to go I think? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Our
Permordering enforces stability of the permutation, even for unstable algorithms. The docs suggested otherwise.Also adds an example to
partialsortpermand removes thealgkeyword from the signature in the docs (we only have partial quicksort).Closes #27112