mikros/rust
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Rollup merge of #119374 - gurry:119149-improve-vec-docs, r=cuviper

Browse Source 
Italicise "bytes" in the docs of some `Vec` methods

On a cursory read it's easy to miss that the limit is in terms of bytes not no. of elements. The italics should help with that.

Fixes #119149
This commit is contained in:
Matthias Krüger 2023-12-29 21:40:22 +01:00 committed by GitHub
commit ef55e757b3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -284,7 +284,7 @@ fn current_memory(&self) -> Option<(NonNull<u8>, Layout)> {
///
/// # Panics
///
/// Panics if the new capacity exceeds `isize::MAX` bytes.
/// Panics if the new capacity exceeds `isize::MAX` _bytes_.
///
/// # Aborts
///
@ -342,7 +342,7 @@ pub fn try_reserve(&mut self, len: usize, additional: usize) -> Result<(), TryRe
///
/// # Panics
///
/// Panics if the new capacity exceeds `isize::MAX` bytes.
/// Panics if the new capacity exceeds `isize::MAX` _bytes_.
///
/// # Aborts
///

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

@ -445,7 +445,7 @@ pub const fn new() -> Self {
///
/// # Panics
///
/// Panics if the new capacity exceeds `isize::MAX` bytes.
/// Panics if the new capacity exceeds `isize::MAX` _bytes_.
///
/// # Examples
///
@ -633,7 +633,7 @@ pub const fn new_in(alloc: A) -> Self {
///
/// # Panics
///
/// Panics if the new capacity exceeds `isize::MAX` bytes.
/// Panics if the new capacity exceeds `isize::MAX` _bytes_.
///
/// # Examples
///
@ -896,7 +896,7 @@ pub fn capacity(&self) -> usize {
///
/// # Panics
///
/// Panics if the new capacity exceeds `isize::MAX` bytes.
/// Panics if the new capacity exceeds `isize::MAX` _bytes_.
///
/// # Examples
///
@ -926,7 +926,7 @@ pub fn reserve(&mut self, additional: usize) {
///
/// # Panics
///
/// Panics if the new capacity exceeds `isize::MAX` bytes.
/// Panics if the new capacity exceeds `isize::MAX` _bytes_.
///
/// # Examples
///
@ -1900,7 +1900,7 @@ fn drop(&mut self) {
///
/// # Panics
///
/// Panics if the new capacity exceeds `isize::MAX` bytes.
/// Panics if the new capacity exceeds `isize::MAX` _bytes_.
///
/// # Examples
///
@ -2003,7 +2003,7 @@ pub fn pop(&mut self) -> Option<T> {
///
/// # Panics
///
/// Panics if the new capacity exceeds `isize::MAX` bytes.
/// Panics if the new capacity exceeds `isize::MAX` _bytes_.
///
/// # Examples
///