From ab43c045edc16d90679810d0384096c859f51a9f Mon Sep 17 00:00:00 2001
From: chip2n <andreas@arvidsson.io>
Date: Fri, 18 Feb 2022 14:02:01 +0100
Subject: [PATCH] Fix incorrect documentation for std.HashMap.remove()

---
 lib/std/hash_map.zig | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/lib/std/hash_map.zig b/lib/std/hash_map.zig
index 53d3f7004d531200746ddaef435643fecbf82444..74d8a9e7c9cff7c0de45942eab49305223b5c9eb 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);
         }
-- 
2.54.0