aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorchip2n <andreas@arvidsson.io>2022-02-18 14:02:01 +0100
committerAndrew Kelley <andrew@ziglang.org>2022-02-18 13:47:38 -0500
commitab43c045edc16d90679810d0384096c859f51a9f (patch)
tree26895f6f973a704fa8ef9f7005a0dc1f16229e38
parent5af9d0c603fa5a4e318326a6d2603131f5da4138 (diff)
downloadzig-ab43c045edc16d90679810d0384096c859f51a9f.tar.gz
zig-ab43c045edc16d90679810d0384096c859f51a9f.zip
Fix incorrect documentation for std.HashMap.remove()
-rw-r--r--lib/std/hash_map.zig3
1 files changed, 2 insertions, 1 deletions
diff --git a/lib/std/hash_map.zig b/lib/std/hash_map.zig
index 53d3f7004d..74d8a9e7c9 100644
--- a/lib/std/hash_map.zig
+++ b/lib/std/hash_map.zig
@@ -629,7 +629,8 @@ pub fn HashMap(
}
/// If there is an `Entry` with a matching key, it is deleted from
- /// the hash map, and then returned from this function.
+ /// the hash map, and this function returns true. Otherwise this
+ /// function returns false.
pub fn remove(self: *Self, key: K) bool {
return self.unmanaged.removeContext(key, self.ctx);
}