]> git.eshelyaron.com Git - emacs.git/commitdiff
Clarify the doc of eval-expression-print-format
authorLars Ingebrigtsen <larsi@gnus.org>
Sat, 30 Apr 2016 15:39:05 +0000 (17:39 +0200)
committerLars Ingebrigtsen <larsi@gnus.org>
Sun, 1 May 2016 17:27:12 +0000 (19:27 +0200)
* lisp/simple.el (eval-expression-print-format): Doc
clarification (bug#19114).

(cherry picked from commit cd193a871f5a8e1c81ba86fc398ac382fa814383)

lisp/simple.el

index 24d2d7fbc0f902d4e76c66a83061044c3e04e38f..97b40bd214e7f9b8537094f1eeb5926c5389d401 100644 (file)
@@ -1418,10 +1418,11 @@ If nil, don't change the value of `debug-on-error'."
   :version "21.1")
 
 (defun eval-expression-print-format (value)
-  "Format VALUE as a result of evaluated expression.
-Return a formatted string which is displayed in the echo area
-in addition to the value printed by prin1 in functions which
-display the result of expression evaluation."
+  "If VALUE in an integer, return a specially formatted string.
+This string will typically look like \" (#o1, #x1, ?\\C-a)\".
+If VALUE is not an integer, nil is returned.
+This function is used by functions like `prin1' that display the
+result of expression evaluation."
   (if (and (integerp value)
           (or (eq standard-output t)
               (zerop (prefix-numeric-value current-prefix-arg))))