better REPLACE docstring

  lp#965592

diff --git a/NEWS b/NEWS
index 47e9548..fbb0734 100644 (file)
--- a/NEWS
+++ b/NEWS
@@ -1,4 +1,8 @@
 ;;;; -*- coding: utf-8; fill-column: 78 -*-
+changes relative to sbcl-1.0.55:
+  * documentation:
+    ** improved docstrings: REPLACE (lp#965592)
+
 changes in sbcl-1.0.56 relative to sbcl-1.0.55:
   * bug fix: fix copy-structure.  When copying from stack to heap, garbage
     could end up in the heap making GC unhappy.

diff --git a/src/code/seq.lisp b/src/code/seq.lisp
index cc02671..3a70741 100644 (file)
--- a/src/code/seq.lisp
+++ b/src/code/seq.lisp
@@ -659,8 +659,13 @@
 (define-sequence-traverser replace
     (sequence1 sequence2 &rest args &key start1 end1 start2 end2)
   #!+sb-doc
-  "The target sequence is destructively modified by copying successive
-   elements into it from the source sequence."
+  "Destructively modifies SEQUENCE1 by copying successive elements
+into it from the SEQUENCE2.
+
+Elements are copied to the subseqeuence bounded by START1 and END1,
+from the subsequence bounded by START2 and END2. If these subsequences
+are not of the same length, then the shorter length determines how
+many elements are copied."
   (declare (truly-dynamic-extent args))
   (let* (;; KLUDGE: absent either rewriting FOO-REPLACE-FROM-BAR, or
          ;; excessively polluting DEFINE-SEQUENCE-TRAVERSER, we rebind