nordic-dev.net/rust
nordic-dev.net/rust
2
0
Fork 0
mirror of https://github.com/rust-lang/rust.git synced 2024-11-27 17:24:06 +00:00
Code Issues Packages Projects Releases Wiki Activity

Rollup merge of #87780 - est31:intra_doc_links, r=jyn514

Browse Source 
alloc: Use intra doc links for the reserve function

The sentence exists to highlight the existence of a
performance footgun of repeated calls of the
reserve_exact function.
This commit is contained in:
Yuki Okushi 2021-08-06 11:21:36 +09:00 committed by GitHub
commit b98c388352
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 15 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
library/alloc/src/collections/vec_deque/mod.rs
View File

@ -697,7 +697,9 @@ impl<T, A: Allocator> VecDeque<T, A> {
/// ///
/// Note that the allocator may give the collection more space than it /// Note that the allocator may give the collection more space than it
/// requests. Therefore, capacity can not be relied upon to be precisely /// requests. Therefore, capacity can not be relied upon to be precisely
/// minimal. Prefer `reserve` if future insertions are expected. /// minimal. Prefer [`reserve`] if future insertions are expected.
///
/// [`reserve`]: VecDeque::reserve
/// ///
/// # Errors /// # Errors
/// ///

4
library/alloc/src/string.rs
View File

@ -1035,7 +1035,9 @@ impl String {
/// ///
/// Note that the allocator may give the collection more space than it /// Note that the allocator may give the collection more space than it
/// requests. Therefore, capacity can not be relied upon to be precisely /// requests. Therefore, capacity can not be relied upon to be precisely
/// minimal. Prefer `reserve` if future insertions are expected. /// minimal. Prefer [`reserve`] if future insertions are expected.
///
/// [`reserve`]: String::reserve
/// ///
/// # Errors /// # Errors
/// ///

8
library/alloc/src/vec/mod.rs
View File

@ -811,7 +811,9 @@ impl<T, A: Allocator> Vec<T, A> {
/// ///
/// Note that the allocator may give the collection more space than it /// Note that the allocator may give the collection more space than it
/// requests. Therefore, capacity can not be relied upon to be precisely /// requests. Therefore, capacity can not be relied upon to be precisely
/// minimal. Prefer `reserve` if future insertions are expected. /// minimal. Prefer [`reserve`] if future insertions are expected.
///
/// [`reserve`]: Vec::reserve
/// ///
/// # Panics /// # Panics
/// ///
@ -875,7 +877,9 @@ impl<T, A: Allocator> Vec<T, A> {
/// ///
/// Note that the allocator may give the collection more space than it /// Note that the allocator may give the collection more space than it
/// requests. Therefore, capacity can not be relied upon to be precisely /// requests. Therefore, capacity can not be relied upon to be precisely
/// minimal. Prefer `reserve` if future insertions are expected. /// minimal. Prefer [`reserve`] if future insertions are expected.
///
/// [`reserve`]: Vec::reserve
/// ///
/// # Errors /// # Errors
/// ///

4
library/std/src/ffi/os_str.rs
View File

@ -271,7 +271,9 @@ impl OsString {
/// ///
/// Note that the allocator may give the collection more space than it /// Note that the allocator may give the collection more space than it
/// requests. Therefore, capacity can not be relied upon to be precisely /// requests. Therefore, capacity can not be relied upon to be precisely
/// minimal. Prefer reserve if future insertions are expected. /// minimal. Prefer [`reserve`] if future insertions are expected.
///
/// [`reserve`]: OsString::reserve
/// ///
/// # Examples /// # Examples
/// ///