Commit 5236842a9d

Andrew Kelley <andrew@ziglang.org>
2023-02-28 06:04:29
std.heap.GeneralPurposeAllocator: add doc comment for deinit
1 parent f33af7a
Changed files (1)
lib/std/heap/general_purpose_allocator.zig
@@ -423,6 +423,7 @@ pub fn GeneralPurposeAllocator(comptime config: Config) type {
             }
         } else struct {};
 
+        /// Returns true if there were leaks; false otherwise.
         pub fn deinit(self: *Self) bool {
             const leaks = if (config.safety) self.detectLeaks() else false;
             if (config.retain_metadata) {