zig

commit d4e5d1e15c1c8ff85f611e82cb9fd7f7084a7b38 (tree)
parent 17928ef58b1ab110c1f944b5991540d4a938b057
Author: 87 <178735591+87flowers@users.noreply.github.com>
Date:   Sun, 15 Jun 2025 13:29:15 +0100

lib: Reword documentation for realloc to clarify size

"byte size" is confusing. Clarify we mean number of items.

Diffstat:
M
lib/std/mem/Allocator.zig
 | 
4
+++-

1 file changed, 3 insertions(+), 1 deletion(-)
diff --git a/lib/std/mem/Allocator.zig b/lib/std/mem/Allocator.zig
@@ -358,8 +358,10 @@ pub fn remap(self: Allocator, allocation: anytype, new_len: usize) t: {
     return mem.bytesAsSlice(T, new_memory);
 }
 
-/// This function requests a new byte size for an existing allocation, which
+/// This function requests a new size for an existing allocation, which
 /// can be larger, smaller, or the same size as the old memory allocation.
+/// The result is an array of `new_n` items of the same type as the existing
+/// allocation.
 ///
 /// If `new_n` is 0, this is the same as `free` and it always succeeds.
 ///