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.

Sign up for GitHub

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

Jump to bottom

BTreeMap/Set should specify iteration is ordered #31129

Closed
Roxxik opened this issue Jan 22, 2016 · 2 comments
Closed

BTreeMap/Set should specify iteration is ordered #31129

Roxxik opened this issue Jan 22, 2016 · 2 comments
Labels
E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue.

Comments

@Roxxik
Copy link

Roxxik commented Jan 22, 2016

I just wanted to note that it is nowhere mentioned that all iterators from there are in sorted order. While I have to admit that it makes sense for a ordered container to provide ordered iterators, it is not documented. In the examples it is assumed that the iterators are ordered, but nowhere explictly stated.
Neither in the BTreeMap nor the BTreeSet.
@Gankra Gankra added the E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue. label Jan 22, 2016
@steveklabnik
Copy link
Member

part of #29348

@Gankra Gankra changed the title BTreeMap/Set documentation BTreeMap/Set should specify iteration is ordered Jan 22, 2016
mbrubeck added a commit to mbrubeck/rust that referenced this issue Jan 22, 2016
@mbrubeck
Document that BTreeMap iteration is in order
f81a11b 
Also change the examples to make this more obvious. Fixes rust-lang#31129.
@mbrubeck mbrubeck mentioned this issue Jan 22, 2016
Merged
steveklabnik added a commit to steveklabnik/rust that referenced this issue Jan 23, 2016
@steveklabnik
Rollup merge of rust-lang#31136 - mbrubeck:btree-doc, r=steveklabnik
96dbd8a 
Also change the examples to make this more obvious. Fixes rust-lang#31129.
steveklabnik added a commit to steveklabnik/rust that referenced this issue Jan 23, 2016
@steveklabnik
Rollup merge of rust-lang#31136 - mbrubeck:btree-doc, r=steveklabnik
b0b1df8 
Also change the examples to make this more obvious. Fixes rust-lang#31129.
@jonhoo
Copy link
Contributor

jonhoo commented Oct 14, 2016 •
edited
Loading

This is not actually closed, as the BTreeSet documentation for iter() still does not mention this. The change was made only for BTreeMap.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@steveklabnik @jonhoo @Gankra @Roxxik