Sorting documentation fixups for 1.9 #48440
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
In particular: * document the `order` keyword in `sort!` * list explicitly the required properties of `lt` in `sort!` * clarify the sequence of "by" transformations if both `by` and `order` are given * show default values in the signatures for `searchsorted` and related functions * add `isunordered` to the manual (it's already exported)
LilithHafner
added
docs
cormullion
reviewed
Jan 29, 2023
cormullion
reviewed
Jan 29, 2023
knuesel
reviewed
Jan 30, 2023
There was a problem hiding this comment.
Looks good to me!
Note that this doesn't include any of my changes (except for two typo fixes) since they're all reverted by 23178f7 (which is totally fine with me, I'm just mentioning it in case the whole revert was done unintentionally).
|
I reverted anything that I felt could plausibly be objectionable so that we can merge this more easily and take a bit of the diff off the table when discussing the remaining PRs |
KristofferC
pushed a commit
that referenced
this pull request
Feb 1, 2023
- Fix typos - Clarify that ! means mutation, not "in-place-ness". This should be backported because sort! is even less in place in 1.9 than it already was in 1.8. - Rewrite the section on default policy to reflect the new default policy - Move examples and extended description of previously default sorting algorithms out of sort.md and into their respective docstrings (still rendered in sort.md) Co-authored-by: Jeremie Knuesel <[email protected]> (cherry picked from commit a1c4d85)
35 tasks
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.
Cherrypicks changes that should be backported to 1.9 from #48387 and #48363.
Part of an effort to break up those two PRs into smaller chunks so that they can merge more easily, starting with backports so that the backporting process can be more automatic.
!means mutation, not "in-place-ness". This should be backported becausesort!is even less in place in 1.9 than it already was in 1.8.Requesting review from @knuesel, an author of some of these changes.
This is intended to update the documentation for everything that changed in 1.9 and therefore fixes #47789