[nfc] Fixed typos in comments in Sort.swift #37892
Merged
Conversation
This file contains hidden or 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
There is still an incongruity between where `srcHigh` and `destHigh` are displayed in the diagram: `srcHigh` is shown at the location it logically represents, not its true position which is one past that, whereas `destHigh` (as well as `bufferHigh`) is shown at its true position (past the end) not at the location it logically represents. I am not sure if that is intentional.
| @@ -555,7 +555,7 @@ extension UnsafeMutableBufferPointer { | |||
| // (a) - for all i in 2..<runs.count: | |||
| // - runs[i - 2].count > runs[i - 1].count + runs[i].count | |||
| // (b) - for c = runs.count - 1: | |||
| // - runs[i - 1].count > runs[i].count | |||
| // - runs[c - 1].count > runs[c].count | |||
stdlib/public/core/Sort.swift
Outdated
| // srcHigh destLow destHigh (past the end) | ||
| // Storage: [4, 4, 7, 8, 9, 16, x, x, x, x, x] | ||
| // ^ ^ ^ | ||
| // srcHigh destLow destHigh (past the end) |
There was a problem hiding this comment.
Yeah, the original is odd for a couple reasons:
- That
6isn't in the right spot; we wouldn't be merging a range of elements that isn't ordered correctly. (You fixed that by changing it to16) srcHighanddestLowpoint to the same position, not consecutive ones. Looking at the loop below, they're actually always the same (because we move elements from the top of the initialized "Storage" region, which shifts the uninitialized region downward). We could eliminate one if that would make things clearer, but they shouldn't depict two different pointers in this diagram.
There was a problem hiding this comment.
Yeah I wasn’t sure if there was a reason for doing it that way.
We could probably do something with, like, slashes as angled lines to show they’re both pointing to the same place.
There was a problem hiding this comment.
Okay I went with a slash, not as an angled line, but as an actual slash.
xwu
reviewed
Jun 15, 2021
xwu
reviewed
Jun 15, 2021
Co-authored-by: Xiaodi Wu <[email protected]>
Thanks! |
|
Beauteous! 💖 |
|
@swift-ci Please smoke test and merge |
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.
No description provided.