sequences: clarify some mutable vs resizeable notes in sequence docs

diff --git a/core/sequences/sequences-docs.factor b/core/sequences/sequences-docs.factor
index 0437b0f3e8cfedc018ab32b1c896630dd179a76f..0d69deaafd5408d19ea981dc80d69f34ca12a9a9 100644 (file)
--- a/core/sequences/sequences-docs.factor
+++ b/core/sequences/sequences-docs.factor
@@ -450,7 +450,6 @@ HELP: change-nth
 HELP: map!
 { $values { "seq" "a mutable sequence" } { "quot" { $quotation ( ... elt -- ... newelt ) } } }
 { $description "Applies the quotation to each element yielding a new element, storing the new elements back in the original sequence. Returns the original sequence." }
-{ $notes "The sequence MUST be resizeable ( see " { $link "vectors" } ")." } 
 { $errors "Throws an error if the sequence is immutable, or the sequence cannot hold elements of the type output by " { $snippet "quot" } "." }
 { $side-effects "seq" } ;
 
@@ -593,7 +592,7 @@ HELP: filter-as
 HELP: filter!
 { $values { "seq" "a resizable mutable sequence" } { "quot" { $quotation ( ... elt -- ... ? ) } } }
 { $description "Applies the quotation to each element in turn, and removes elements for which the quotation outputs a false value." }
-{ $notes "The sequence MUST be resizeable ( see " { $link "vectors" } ")." } 
+{ $notes "The sequence " { $snippet "seq" } " MUST be growable. See " { $link "growable" } "." }
 { $side-effects "seq" }
 { $examples
   "Remove the odd numbers"
@@ -615,7 +614,7 @@ HELP: reject-as
 HELP: reject!
 { $values { "seq" "a resizable mutable sequence." } { "quot" { $quotation ( ... elt -- ... ? ) } } }
 { $description "Applies the quotation to each element in turn, and removes elements for which the quotation outputs a true value." }
-{ $notes "The sequence MUST be resizeable ( see " { $link "vectors" } ")." } 
+{ $notes "The sequence " { $snippet "seq" } " MUST be growable. See " { $link "growable" } "." }
 { $side-effects "seq" }
 { $examples
   "Remove the odd numbers"
@@ -698,7 +697,7 @@ HELP: move
 HELP: remove!
 { $values { "elt" object } { "seq" "a resizable mutable sequence" } }
 { $description "Removes all elements equal to " { $snippet "elt" } " from " { $snippet "seq" } " and returns " { $snippet "seq" } "." }
-{ $notes "The sequence MUST be resizeable ( see " { $link "vectors" } ")." } 
+{ $notes "The sequence " { $snippet "seq" } " MUST be growable. See " { $link "growable" } "." }
 { $notes "This word uses equality comparison (" { $link = } ")." }
 { $side-effects "seq" } ;
 
@@ -711,7 +710,7 @@ HELP: remove-eq!
 HELP: remove-nth!
 { $values { "n" "a non-negative integer" } { "seq" "a resizable mutable sequence" } }
 { $description "Removes the " { $snippet "n" } "th element from the sequence, shifting all other elements down and reducing its length by one." }
-{ $notes "The sequence MUST be resizeable ( see " { $link "vectors" } ")." } 
+{ $notes "The sequence " { $snippet "seq" } " MUST be growable. See " { $link "growable" } "." }
 { $side-effects "seq" } ;
 
 HELP: delete-slice
@@ -729,25 +728,24 @@ HELP: replace-slice
 HELP: suffix
 { $values { "seq" sequence } { "elt" object } { "newseq" sequence } }
 { $description "Outputs a new sequence obtained by adding " { $snippet "elt" } " at the end of " { $snippet "seq" } "." }
-{ $notes "The sequence MUST be resizeable ( see " { $link "vectors" } ")." } 
 { $errors "Throws an error if the type of " { $snippet "elt" } " is not permitted in sequences of the same class as " { $snippet "seq1" } "." }
 { $examples
     { $example "USING: prettyprint sequences ;" "{ 1 2 3 } 4 suffix ." "{ 1 2 3 4 }" }
 } ;
 
 HELP: suffix!
-{ $values { "seq" sequence } { "elt" object } }
+{ $values { "seq" "a resizable mutable sequence." } { "elt" object } }
 { $description "Modifiers a sequence in-place by adding " { $snippet "elt" } " to the end of " { $snippet "seq" } ". Outputs " { $snippet "seq" } "." }
-{ $notes "The sequence MUST be resizeable ( see " { $link "vectors" } ")." } 
+{ $notes "The sequence " { $snippet "seq" } " MUST be growable. See " { $link "growable" } "." }
 { $errors "Throws an error if the type of " { $snippet "elt" } " is not permitted in sequences of the same class as " { $snippet "seq" } "." }
 { $examples
     { $example "USING: prettyprint sequences ;" "V{ 1 2 3 } 4 suffix! ." "V{ 1 2 3 4 }" }
 } ;
 
 HELP: append!
-{ $values { "seq1" sequence } { "seq2" sequence } }
+{ $values { "seq1" "a resizable mutable sequence." } { "seq2" sequence } }
 { $description "Modifiers " { $snippet "seq1" } " in-place by adding the elements from " { $snippet "seq2" } " to the end and outputs " { $snippet "seq1" } "." }
-{ $notes "The sequence MUST be resizeable ( see " { $link "vectors" } ")." } 
+{ $notes "The sequence " { $snippet "seq1" } " MUST be growable. See " { $link "growable" } "." }
 { $examples
     { $example "USING: prettyprint sequences ;" "V{ 1 2 3 } { 4 5 6 } append! ." "V{ 1 2 3 4 5 6 }" }
 } ;
@@ -835,7 +833,6 @@ HELP: exchange
 HELP: reverse!
 { $values { "seq" "a mutable sequence" } }
 { $description "Reverses a sequence in-place and outputs that sequence." }
-{ $notes "The sequence MUST be resizeable ( see " { $link "vectors" } ")." } 
 { $side-effects "seq" } ;
 
 HELP: padding