Improve documentation of replace-buffer-contents

* etc/NEWS (replace-buffer-contents): Fix formatting.

* src/editfns.c (Freplace_buffer_contents): Doc fix.

diff --git a/etc/NEWS b/etc/NEWS
index b3b2031c58282321aca9af9c2ba466b64ddb7d9e..85d12733670ed24031fd7970434dd09c4f6dfcd3 100644 (file)
--- a/etc/NEWS
+++ b/etc/NEWS
@@ -462,10 +462,11 @@ Negative prefix arg flips the direction of selection.  Also,
 defun are selected unless they are separated from the defun by a blank
 line.
 
-** New command 'replace-buffer-contents'.  This command replaces the
-contents of the accessible portion of the current buffer with the
-contents of the accessible portion of a different buffer while keeping
-point, mark, markers, and text properties as intact as possible.
+** New command 'replace-buffer-contents'.
+This command replaces the contents of the accessible portion of the
+current buffer with the contents of the accessible portion of a
+different buffer while keeping point, mark, markers, and text
+properties as intact as possible.
 
 \f
 * Changes in Specialized Modes and Packages in Emacs 26.1

diff --git a/src/editfns.c b/src/editfns.c
index e8ad83e29b8513a41c0892c48e303d5292b7d77e..f0c4593742d6a48aed4178e066a1608c8cca975b 100644 (file)
--- a/src/editfns.c
+++ b/src/editfns.c
@@ -3140,7 +3140,9 @@ static bool buffer_chars_equal (struct context *, OFFSET, OFFSET);
 
 DEFUN ("replace-buffer-contents", Freplace_buffer_contents,
        Sreplace_buffer_contents, 1, 1, "bSource buffer: ",
-       doc: /* Replace accessible portion of the current buffer with accessible portion of SOURCE.
+       doc: /* Replace accessible portion of current buffer with that of SOURCE.
+SOURCE can be a buffer or a string that names a buffer.
+Interactively, prompt for SOURCE.
 As far as possible the replacement is non-destructive, i.e. existing
 buffer contents, markers, properties, and overlays in the current
 buffer stay intact.  */)