Skip to content
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.

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

[OrderedCollections] Document Sorting as Stable #186

Closed
benrimmington opened this issue Sep 25, 2022 · 3 comments
Closed

[OrderedCollections] Document Sorting as Stable #186

benrimmington opened this issue Sep 25, 2022 · 3 comments
Labels
enhancement New feature or request
Milestone

Comments

@benrimmington
Copy link

There are three pairs of sort(by:) and sort() methods, documented with:

The sorting algorithm is not guaranteed to be stable.

  • OrderedDictionary.Elements.sort(by:)
  • OrderedDictionary.Elements.sort()
  • OrderedDictionary.sort(by:)
  • OrderedDictionary.sort()
  • OrderedSet.sort(by:)
  • OrderedSet.sort()

Should these APIs be documented like the SE-0372 implementation?

@benrimmington benrimmington added the enhancement New feature or request label Sep 25, 2022
@lorentey lorentey added this to the 1.0.4 milestone Oct 9, 2022
@lorentey
Copy link
Member

lorentey commented Oct 9, 2022

Yep. I believe we can safely make this change in the next patch release, 1.0.4.

@lorentey
Copy link
Member

Suggested fix is up at #201 -- cc @benrimmington.

@lorentey
Copy link
Member

Fix is merged to release/1.0. The changes will propagate to release/1.1 and main with the next (manual) merge.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants