zig

commit 5bb4fef30a1b12fde3e3a20c2def301f7fd32fab (tree)
parent 525466b49d4acc0d33f528bc9d53392c309a43bd
Author: godalming123 <68993177+godalming123@users.noreply.github.com>
Date:   Tue, 25 Mar 2025 06:19:28 +0000

Update the documentation comment in arena_allocator.zig to be more accurate

Update the documentation comment in arena_allocator.zig to specify that free() is a no-op unless the item is the most recent allocation.
Diffstat:
M
lib/std/heap/arena_allocator.zig
 | 
6
++++--

1 file changed, 4 insertions(+), 2 deletions(-)
diff --git a/lib/std/heap/arena_allocator.zig b/lib/std/heap/arena_allocator.zig
@@ -3,8 +3,10 @@ const assert = std.debug.assert;
 const mem = std.mem;
 const Allocator = std.mem.Allocator;
 
-/// This allocator takes an existing allocator, wraps it, and provides an interface
-/// where you can allocate without freeing, and then free it all together.
+/// This allocator takes an existing allocator, wraps it, and provides an interface where
+/// you can allocate and then free it all together. Calls to free an individual item only
+/// free the item if it was the most recent allocation, otherwise calls to free do
+/// nothing.
 pub const ArenaAllocator = struct {
     child_allocator: Allocator,
     state: State,