std: fix doc comment of GPA deinit

Philipp Lühmann · andrewrk · commit de227ace14e0 · 2023-07-03T01:14:20.000-07:00
This was missed in #15269
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) {

Original file line number	Diff line number	Diff line change
`@@ -433,7 +433,7 @@ pub fn GeneralPurposeAllocator(comptime config: Config) type {`
`433`	`433`	`}`
`434`	`434`	`} else struct {};`
`435`	`435`
`436`		`- /// Returns true if there were leaks; false otherwise.`
	`436`	+ /// Returns `Check.leak` if there were leaks; `Check.ok` otherwise.
`437`	`437`	`pub fn deinit(self: *Self) Check {`
`438`	`438`	`const leaks = if (config.safety) self.detectLeaks() else false;`
`439`	`439`	`if (config.retain_metadata) {`