From 15c94b5c920b024a15039280f86c70585925b1fb Mon Sep 17 00:00:00 2001
From: chunes3 <krenium@protonmail.com>
Date: Sun, 10 Sep 2023 17:00:35 -0500
Subject: [PATCH] Add documentation for sift!

---
 extra/sequences/extras/extras-docs.factor | 16 +++++++++++++---
 extra/sequences/extras/extras.factor      |  2 +-
 2 files changed, 14 insertions(+), 4 deletions(-)

diff --git a/extra/sequences/extras/extras-docs.factor b/extra/sequences/extras/extras-docs.factor
index b8c795fcf2..ab02cb4765 100644
--- 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
diff --git a/extra/sequences/extras/extras.factor b/extra/sequences/extras/extras.factor
index ed97389d29..81de4b8e28 100644
--- a/extra/sequences/extras/extras.factor
+++ b/extra/sequences/extras/extras.factor
@@ -498,7 +498,7 @@ PRIVATE>
 : sift-as ( seq exemplar -- newseq )
     [ ] swap filter-as ;
 
-: sift! ( seq -- newseq )
+: sift! ( seq -- seq' )
     [ ] filter! ;
 
 : harvest-as ( seq exemplar -- newseq )
-- 
2.34.1