Subject: Re: bug#19932: 25.0.50; doc string of `elisp--eval-last-sexp'

From: Nicolas Richard <[email-masked]>
Date: Wed, 25 Feb 2015 13:12:00 +0100

Dmitry Gutov <[email-masked]> writes:
> On 02/25/2015 12:52 PM, Nicolas Richard wrote:
>
>> FWIW, I like when functions are documented, even private ones.
>
> Would you like to enforce your preference and provide a patch that
> improves on the discussed drawbacks in that docstring?

Would the following fit ? (I should be able to push it, if it turns out
to be ok.)

It's not as precise as what Drew suggested, but I didn't feel like being
too verbose.

>From 31d11bc29fd5157f2ff0f41e6d5d39b1115fcf8f Mon Sep 17 00:00:00 2001
From: Nicolas Richard <[email-masked]>
Date: Wed, 25 Feb 2015 13:07:43 +0100
Subject: [PATCH] lisp/progmodes/elisp-mode.el (elisp--eval-last-sexp):
 Document argument.

Fixes: 19932
---
 lisp/ChangeLog               | 4 ++++
 lisp/progmodes/elisp-mode.el | 4 ++--
 2 files changed, 6 insertions(+), 2 deletions(-)

diff --git a/lisp/ChangeLog b/lisp/ChangeLog
index e32dab0..f4f6097 100644
--- a/lisp/ChangeLog
+++ b/lisp/ChangeLog
@@ -1,3 +1,7 @@
+2015-02-25  Nicolas Richard  <[email-masked]>
+
+	* progmodes/elisp-mode.el (elisp--eval-last-sexp): Document argument.
+
 2014-12-23  Nicolas Richard  <[email-masked]>
 
 	* simple.el (count-words-region): Act on buffer if there is no region.
diff --git a/lisp/progmodes/elisp-mode.el b/lisp/progmodes/elisp-mode.el
index b2c5fbf..42e946c 100644
--- a/lisp/progmodes/elisp-mode.el
+++ b/lisp/progmodes/elisp-mode.el
@@ -883,8 +883,8 @@ (define-obsolete-function-alias 'preceding-sexp 'elisp--preceding-sexp "25.1")
 
 (defun elisp--eval-last-sexp (eval-last-sexp-arg-internal)
   "Evaluate sexp before point; print value in the echo area.
-With argument, print output into current buffer.
-With a zero prefix arg, print output with no limit on the length
+If EVAL-LAST-SEXP-ARG-INTERNAL is non-nil, print output into current buffer.
+If EVAL-LAST-SEXP-ARG-INTERNAL is `0', print output with no limit on the length
 and level of lists, and include additional formats for integers
 \(octal, hexadecimal, and character)."
   (let ((standard-output (if eval-last-sexp-arg-internal (current-buffer) t)))
-- 
2.1.4

-- 
Nicolas Richard