Allow circular clumps with a length smaller than the clump

[factor.git] / basis / grouping / grouping-docs.factor

diff --git a/basis/grouping/grouping-docs.factor b/basis/grouping/grouping-docs.factor
index 83f9173f1fc128e25badf40c4fcc97374389629f..64f277ee940d30d8db08af30ce494e5b7c94a6ed 100644 (file)
--- a/basis/grouping/grouping-docs.factor
+++ b/basis/grouping/grouping-docs.factor
@@ -125,7 +125,7 @@ HELP: clump
 HELP: circular-clump
 { $values { "seq" "a sequence" } { "n" "a non-negative integer" } { "array" "a sequence of sequences" } }
 { $description "Splits the sequence into overlapping clumps of " { $snippet "n" } " elements, wrapping around the end of the sequence, and collects the clumps into a new array." }
-{ $errors "Throws an error if " { $snippet "n" } " is larger than the length of the sequence." }
+{ $notes "For an empty sequence, the result is an empty sequence." }
 { $examples
     { $example "USING: grouping prettyprint ;" "{ 3 1 3 3 7 } 2 circular-clump ." "{ { 3 1 } { 1 3 } { 3 3 } { 3 7 } { 7 3 } }" }
 } ;