Skip to content

Update documentation to use from() to initialize HashMaps and BTreeMaps #91482

New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Merged
merged 3 commits into from
Dec 11, 2021
Merged

Update documentation to use from() to initialize HashMaps and BTreeMaps #91482

merged 3 commits into from
Dec 11, 2021

Conversation

JosephTLyons
Copy link
Contributor

@JosephTLyons JosephTLyons commented Dec 3, 2021

As of Rust 1.56, HashMap and BTreeMap both have associated from() functions. I think using these in the documentation cleans things up a bit. It allows us to remove some of the muts and avoids the Initialize-Then-Modify anti-pattern.

@rust-highfive
Copy link
Contributor

r? @yaahc

(rust-highfive has picked a reviewer for you, use r? to override)

@rust-highfive rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Dec 3, 2021
@rust-log-analyzer

This comment has been minimized.

@JosephTLyons JosephTLyons changed the title update HashMap and BTreeMap documentation Update documentation to use from() to initialize HashMaps and BTreeMaps Dec 3, 2021
@JosephTLyons JosephTLyons marked this pull request as ready for review December 3, 2021 07:18
@apiraino apiraino added the T-libs Relevant to the library team, which will review and decide on the PR/issue. label Dec 9, 2021
@yaahc
Copy link
Member

yaahc commented Dec 10, 2021

I agree this looks much better, thank you very much!

@bors r+ rollup

@bors
Copy link
Collaborator

bors commented Dec 10, 2021

📌 Commit 72a6974 has been approved by yaahc

@bors
Copy link
Collaborator

bors commented Dec 10, 2021

🌲 The tree is currently closed for pull requests below priority 100. This pull request will be tested once the tree is reopened.

@bors bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Dec 10, 2021
matthiaskrgr added a commit to matthiaskrgr/rust that referenced this pull request Dec 10, 2021
…eeMap-documentation, r=yaahc

Update documentation to use `from()` to initialize `HashMap`s and `BTreeMap`s

As of Rust 1.56, `HashMap` and `BTreeMap` both have associated `from()` functions.  I think using these in the documentation cleans things up a bit.  It allows us to remove some of the `mut`s and avoids the Initialize-Then-Modify anti-pattern.
bors added a commit to rust-lang-ci/rust that referenced this pull request Dec 10, 2021
…askrgr

Rollup of 10 pull requests

Successful merges:

 - rust-lang#90407 (Document all public items in `rustc_incremental`)
 - rust-lang#90897 (Fix incorrect stability attributes)
 - rust-lang#91105 (Fix method name reference in stream documentation)
 - rust-lang#91325 (adjust const_eval_select documentation)
 - rust-lang#91470 (code-cov: generate dead functions with private/default linkage)
 - rust-lang#91482 (Update documentation to use `from()` to initialize `HashMap`s and `BTreeMap`s)
 - rust-lang#91524 (Fix Vec::extend_from_slice docs)
 - rust-lang#91575 (Fix ICE on format string of macro with secondary-label)
 - rust-lang#91625 (Remove redundant [..]s)
 - rust-lang#91646 (Fix documentation for `core::ready::Ready`)

Failed merges:

r? `@ghost`
`@rustbot` modify labels: rollup
@bors bors merged commit 5510803 into rust-lang:master Dec 11, 2021
@rustbot rustbot added this to the 1.59.0 milestone Dec 11, 2021
@JosephTLyons JosephTLyons deleted the update-HashMap-and-BTreeMap-documentation branch December 11, 2021 02:37
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. T-libs Relevant to the library team, which will review and decide on the PR/issue.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants