Remove collection-specific with_capacity documentation from std::collections
#59984
Conversation
|
Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @rkruppe (or someone else) soon. If any changes to this PR are deemed necessary, please add them as extra commits. This ensures that the reviewer can see what has changed since they last reviewed the code. Due to the way GitHub handles out-of-date commits, this should also make it reasonably obvious what issues have or haven't been addressed. Large or tricky changes may require several passes of review and changes. Please see the contribution instructions for more information. |
rust-highfive
added
the
S-waiting-on-review
|
Thank you! It looks good to me and I'm going to approve this, but for visibility I'm going to mention @rust-lang/docs in case one of them has an opinion on dropping the mention of @bors r+ rollup |
|
📌 Commit 64dc041 has been approved by |
bors
added
S-waiting-on-bors
…c-fix, r=rkruppe Remove collection-specific `with_capacity` documentation from `std::collections` Fixes rust-lang#59931 The style of `std::collections` module doc is very much a beginner friendly guide, and documenting niche, collection-specific behaviour feels out of place, if not brittle. The note about `VecDeque` is outdated (see issue), and while `Vec` probably won't change its guarantees any time soon, the users who are interested in its allocation properties will find that in its own documentation.
Rollup of 4 pull requests Successful merges: - #59908 (Re-export core::str::{EscapeDebug, EscapeDefault, EscapeUnicode} in std) - #59984 (Remove collection-specific `with_capacity` documentation from `std::collections`) - #60036 (Remove nrc from toolstate pings) - #60037 (Resolve inconsistency in error messages between "parameter" and "variable".) Failed merges: r? @ghost
Fixes #59931
The style of
std::collectionsmodule doc is very much a beginner friendly guide, and documenting niche, collection-specific behaviour feels out of place, if not brittle.The note about
VecDequeis outdated (see issue), and whileVecprobably won't change its guarantees any time soon, the users who are interested in its allocation properties will find that in its own documentation.