]> code.delx.au - gnu-emacs/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>
Sat, 30 Apr 2016 15:39:05 +0000 (17:39 +0200)
* lisp/simple.el (eval-expression-print-format): Doc
clarification (bug#19114).

lisp/simple.el

index da6deea3e84c2b9541afea3be7aca0f204802e88..1247cb25da2c8ad7dcb3a7af0a063b5e366a1658 100644 (file)
@@ -1420,10 +1420,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))))