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

BTreeMap documentation improvement #39661

Closed
Henning-K opened this issue Feb 8, 2017 · 1 comment
Closed

BTreeMap documentation improvement #39661

Henning-K opened this issue Feb 8, 2017 · 1 comment
Labels
E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue. E-mentor Call for participation: This issue has a mentor. Use #t-compiler/help on Zulip for discussion.

Comments

@Henning-K
Copy link
Contributor

On the page https://doc.rust-lang.org/std/collections/index.html there is a comparison of the collection types in the standard library and it says under "Use a BTreeMap when:" "You want a sorted map.".

It was not immediately clear to me that the map's Key/Value pairs are in fact sorted by its keys. This was only fully clarified by asking the helpful folks over on IRC.

Steve Klabnik then encouraged me to open an issue here asking for a change in the docs clarifying the point made above.

This point in the list/comparison should probably say something more like
"You want a map sorted by its keys."
to avoid any unnecessary ambiguity.

@steveklabnik steveklabnik added A-docs E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue. E-mentor Call for participation: This issue has a mentor. Use #t-compiler/help on Zulip for discussion. labels Feb 8, 2017
@steveklabnik
Copy link
Member

I agree wholeheartedly, thanks for filing! I'm willing to help mentor anyone who wants to fix this bug.

frewsxcv added a commit to frewsxcv/rust that referenced this issue Feb 9, 2017
GuillaumeGomez added a commit to GuillaumeGomez/rust that referenced this issue Feb 12, 2017
@bors bors closed this as completed in 51ef003 Feb 12, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue. E-mentor Call for participation: This issue has a mentor. Use #t-compiler/help on Zulip for discussion.
Projects
None yet
Development

No branches or pull requests

2 participants