Add AA.remove() return behaviour

dlang · Jun 4, 2013 · 7e591a5 · 7e591a5
1 parent 5077568
commit 7e591a5
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/hash-map.dd b/hash-map.dd
@@ -26,6 +26,10 @@ func(b["hello"]); // pass 3 as parameter to func()
 ---------
 b.$(CODE_HIGHLIGHT remove)("hello");
 ---------
+        $(P remove(key) does nothing if the given $(I key) does not exist and
+        returns $(B false).  If the given $(I key) does exist, it removes it
+        from the AA and returns $(B true).
+        )
 
         $(P The $(I InExpression) yields a pointer to the value
         if the key is in the associative array, or $(D null) if not: