zig

commit de227ace14e09c7c17a60f716b88d2327fee201d (tree)
parent fc9ab5f0e838196e99d1706e4d4e91f3d761d509
Author: Philipp Lühmann <spam@philipp.lu>
Date:   Sun,  2 Jul 2023 20:13:51 +0200

std: fix doc comment of GPA deinit

This was missed in #15269

Diffstat:
M
lib/std/heap/general_purpose_allocator.zig
 | 
2
+-

1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/lib/std/heap/general_purpose_allocator.zig b/lib/std/heap/general_purpose_allocator.zig
@@ -433,7 +433,7 @@ pub fn GeneralPurposeAllocator(comptime config: Config) type {
             }
         } else struct {};
 
-        /// Returns true if there were leaks; false otherwise.
+        /// Returns `Check.leak` if there were leaks; `Check.ok` otherwise.
         pub fn deinit(self: *Self) Check {
             const leaks = if (config.safety) self.detectLeaks() else false;
             if (config.retain_metadata) {