]> git.eshelyaron.com Git - emacs.git/commitdiff
Improve the with-output-to-temp-buffer doc string
authorLars Ingebrigtsen <larsi@gnus.org>
Sat, 15 Jan 2022 08:30:01 +0000 (09:30 +0100)
committerLars Ingebrigtsen <larsi@gnus.org>
Sat, 15 Jan 2022 08:30:01 +0000 (09:30 +0100)
* lisp/subr.el (with-output-to-temp-buffer): Clarify the point of
the macro (bug#53265).

lisp/subr.el

index dd260dfe418ef26fcc0b28490c4fc869a0e2854e..81c02338531cdcbe140fcbcba46befd65d5961c8 100644 (file)
@@ -4294,11 +4294,13 @@ in which case `save-window-excursion' cannot help."
 (defmacro with-output-to-temp-buffer (bufname &rest body)
   "Bind `standard-output' to buffer BUFNAME, eval BODY, then show that buffer.
 
-This construct makes buffer BUFNAME empty before running BODY.
-It does not make the buffer current for BODY.
-Instead it binds `standard-output' to that buffer, so that output
-generated with `prin1' and similar functions in BODY goes into
-the buffer.
+This is a convenience macro meant for displaying help buffers and
+the like.  It empties the BUFNAME buffer before evaluating BODY
+and disables undo in that buffer.
+
+It does not make the buffer current for BODY.  Instead it binds
+`standard-output' to that buffer, so that output generated with
+`prin1' and similar functions in BODY goes into the buffer.
 
 At the end of BODY, this marks buffer BUFNAME unmodified and displays
 it in a window, but does not select it.  The normal way to do this is