Skip to content

Commit 682c5af

Browse files
committed
Adjust documentation
1 parent 666e709 commit 682c5af

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

packages/std/src/memory.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ pub fn alloc(size: usize) -> *mut Region {
3333
/// Similar to alloc, but instead of creating a new vector it consumes an existing one and returns
3434
/// a pointer to the Region (preventing the memory from being freed until explicitly called later).
3535
///
36-
/// The resulting Region has capacity = length, the buffer capacity is shrunk down to its length.
36+
/// The resulting Region spans the entire region allocated by the vector, preserving the length and capacity components.
3737
pub fn release_buffer(buffer: Vec<u8>) -> *mut Region {
3838
let region = build_region(&buffer);
3939
mem::forget(buffer);

0 commit comments

Comments
 (0)