Commit `5bb4fef30a`

godalming123 <68993177+godalming123@users.noreply.github.com>

2025-03-25 07:19:28

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.

master

1 parent 525466b

Changed files (1)

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,

Commit 5bb4fef30a

Commit `5bb4fef30a`