Add documentation for sift!

[factor.git] / extra / sequences / extras / extras-docs.factor

diff --git a/extra/sequences/extras/extras-docs.factor b/extra/sequences/extras/extras-docs.factor
index b8c795fcf222faca33604006d65bf0ffc1a60c13..ab02cb4765b289614bfd5c75bc76b609bcf106ab 100644 (file)
--- a/extra/sequences/extras/extras-docs.factor
+++ b/extra/sequences/extras/extras-docs.factor
@@ -1259,9 +1259,19 @@ HELP: shorten*
 
 HELP: sift!
 { $values
-    { "seq" sequence }
-    { "newseq" sequence }
-} ;
+    { "seq" { "a resizable mutable " { $link sequence } } }
+    { "seq'" { "a resizable mutable " { $link sequence } } }
+}
+{ $description "Removes all instances of " { $link f } " from a sequence." }
+{ $side-effects "seq" }
+{ $examples
+    { $example
+        "USING: prettyprint sequences.extras ;"
+        "V{ 2 f \"a\" f { } f } sift! ."
+        "V{ 2 \"a\" { } }"
+    }
+}
+{ $see-also sift filter! filter harvest! harvest } ;
 
 HELP: sift-as
 { $values