clarify SHUFFLE docstring
authorNikodemus Siivola <nikodemus@random-state.net>
Fri, 30 Mar 2012 15:05:35 +0000 (18:05 +0300)
committerNikodemus Siivola <nikodemus@random-state.net>
Fri, 30 Mar 2012 15:05:35 +0000 (18:05 +0300)
  It's destructive.

sequences.lisp

index e7f1925..9e4ff74 100644 (file)
@@ -81,8 +81,9 @@ share structure with it."
 
 (defun shuffle (sequence &key (start 0) end)
   "Returns a random permutation of SEQUENCE bounded by START and END.
-Permuted sequence may share storage with the original one. Signals an
-error if SEQUENCE is not a proper sequence."
+Original sequece may be destructively modified, and share storage with
+the original one. Signals an error if SEQUENCE is not a proper
+sequence."
   (declare (type fixnum start)
            (type (or fixnum null) end))
   (etypecase sequence