refactor: make alphabetical sort implementation more intuitive #833
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
When looking into the implementation to understand behavior, it's very confusing to invert the ordering in relation to how te mental model works. This aligns implementation and mental model of the sort of versions in the end Signed-off-by: Sebastian Di Luzio <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
When looking into the implementation to understand behavior, it's very confusing to invert the ordering in relation to how the mental model works. This aligns implementation and mental model of the sort of versions in the end.
The part that was most confusing in my experience is that the docs vaguely mention "latest" and "last" element, but when looking at the implenetation, it seems we take the first element of the array - this is very unintuitive, and only makes sense after understanding that the implementation internally sorts exactly the other way around. This change should have no real impact on performance, but should make the code much more readable in my opinion. Tests are unchanged, because behavior is unchanged.