summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLars Ingebrigtsen <larsi@gnus.org>2016-04-30 17:39:05 +0200
committerLars Ingebrigtsen <larsi@gnus.org>2016-05-01 19:27:12 +0200
commited8474e6ff468b3f395f634c032e8f6cee7b8bde (patch)
tree967b195566d7d0c2526581d6be3da703802b4782
parent8f1e784f19c74702947c99d321d20fd1156b432c (diff)
downloademacs-ed8474e6ff468b3f395f634c032e8f6cee7b8bde.tar.gz
Clarify the doc of eval-expression-print-format
* lisp/simple.el (eval-expression-print-format): Doc clarification (bug#19114). (cherry picked from commit cd193a871f5a8e1c81ba86fc398ac382fa814383)
-rw-r--r--lisp/simple.el9
1 files changed, 5 insertions, 4 deletions
diff --git a/lisp/simple.el b/lisp/simple.el
index 24d2d7fbc0f..97b40bd214e 100644
--- a/lisp/simple.el
+++ b/lisp/simple.el
@@ -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))))