From: Lars Ingebrigtsen <larsi@gnus.org>
Date: Sat, 30 Apr 2016 15:39:05 +0000 (+0200)
Subject: Clarify the doc of eval-expression-print-format
X-Git-Tag: emacs-26.0.90~2079
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=cd193a871f5a8e1c81ba86fc398ac382fa814383;p=emacs.git

Clarify the doc of eval-expression-print-format

* lisp/simple.el (eval-expression-print-format): Doc
clarification (bug#19114).
---

diff --git a/lisp/simple.el b/lisp/simple.el
index da6deea3e84..1247cb25da2 100644
--- a/lisp/simple.el
+++ b/lisp/simple.el
@@ -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))))