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

SplayTreeMap documentation does not say keys are in order #51055

Open
whesse opened this issue Jan 18, 2023 · 1 comment
Open

SplayTreeMap documentation does not say keys are in order #51055

whesse opened this issue Jan 18, 2023 · 1 comment
Assignees
Labels
area-core-library SDK core library issues (core, async, ...); use area-vm or area-web for platform specific libraries. library-core type-documentation A request to add or improve documentation

Comments

@whesse
Copy link
Contributor

whesse commented Jan 18, 2023

The documentation of the SplayTreeMap class does not say that keys are iterated in order.

The [page]9https://api.dart.dev/stable/2.18.7/dart-collection/dart-collection-library.html) for the collections library links to SplayTreeMap with a statement that it iterates the keys in order, but this is missing from the documentation for the class itself, and from the pages for the key, entries, and value getters, as well as other iterators.

For SplayTreeMap, these methods are marked as overridden, and have their own documentation pages, but on other Map impementations, they just link to the methods on Map, and so don't specify order.

@whesse whesse added library-core area-documentation Prefer using 'type-documentation' and a specific area label. labels Jan 18, 2023
@Cat-sushi
Copy link

I saw several people trying to sort by values.

@devoncarew devoncarew added type-documentation A request to add or improve documentation area-core-library SDK core library issues (core, async, ...); use area-vm or area-web for platform specific libraries. and removed area-documentation Prefer using 'type-documentation' and a specific area label. labels Apr 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area-core-library SDK core library issues (core, async, ...); use area-vm or area-web for platform specific libraries. library-core type-documentation A request to add or improve documentation
Projects
None yet
Development

No branches or pull requests

4 participants