From 5236842a9d0f7b0a82c440bcc08d315db4051d48 Mon Sep 17 00:00:00 2001
From: Andrew Kelley <andrew@ziglang.org>
Date: Mon, 27 Feb 2023 22:04:29 -0700
Subject: [PATCH] std.heap.GeneralPurposeAllocator: add doc comment for deinit

---
 lib/std/heap/general_purpose_allocator.zig | 1 +
 1 file changed, 1 insertion(+)

diff --git a/lib/std/heap/general_purpose_allocator.zig b/lib/std/heap/general_purpose_allocator.zig
index 452480dc7a..fed6eba47b 100644
--- a/lib/std/heap/general_purpose_allocator.zig
+++ b/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) {