]> gitweb.factorcode.org Git - factor.git/blobdiff - core/sets/sets-docs.factor
sets: adding ?delete that returns a boolean if elt was deleted from set.
[factor.git] / core / sets / sets-docs.factor
index beed7fd8a477236b1756b38f3e4a288bdf108864..a3645d8f757c45a7b74d276fa9c4fbc8d3e0c549 100644 (file)
@@ -93,14 +93,17 @@ HELP: adjoin
 
 HELP: ?adjoin
 { $values { "elt" object } { "set" set } { "?" boolean } }
-{ $description "A version of " { $link adjoin } " which returns whether the element was added to the set." }
-{ $notes "This is slightly less efficient than " { $link adjoin } " due to the initial membership test." } ;
+{ $description "A version of " { $link adjoin } " which returns whether the element was added to the set." } ;
 
 HELP: delete
 { $values { "elt" object } { "set" set } }
 { $description "Destructively removes " { $snippet "elt" } " from " { $snippet "set" } ". If the element is not present, this does nothing." $nl "Each mutable set type is expected to implement a method on this generic word." }
 { $side-effects "set" } ;
 
+HELP: ?delete
+{ $values { "elt" object } { "set" set } { "?" boolean } }
+{ $description "A version of " { $link delete } " which returns whether the element was removed from the set." } ;
+
 HELP: clear-set
 { $values { "set" set } }
 { $contract "Removes all entries from the set." }