emacs-devel
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

message's docstring


From: Juanma Barranquero
Subject: message's docstring
Date: Sun, 12 Nov 2006 01:11:02 +0100

Two slight inconsistencies/problems in message's docstring:

1) It says:

DEFUN ("message", Fmessage, Smessage, 1, MANY, 0,
      doc: /* Print a one-line message at the bottom of the screen.

Why "a one-line message"? There's nothing stopping

 (message "line 1\nline 2")

for working, or even

 (message "%s\n%s" "line1" "line2")

2) The docstring doesn't mention that the message is returned.
However, several modules do rely on it (files.el, for example, has
"(y-or-n-p (message ...))".

It is OK the following change, or there are policy issues here?

                   /L/e/k/t/u


Index: src/editfns.c
===================================================================
RCS file: /cvsroot/emacs/emacs/src/editfns.c,v
retrieving revision 1.428
diff -u -2 -r1.428 editfns.c
--- src/editfns.c       11 Sep 2006 08:26:47 -0000      1.428
+++ src/editfns.c       11 Nov 2006 23:48:16 -0000
@@ -3172,7 +3172,8 @@

DEFUN ("message", Fmessage, Smessage, 1, MANY, 0,
-       doc: /* Print a one-line message at the bottom of the screen.
+       doc: /* Print a message at the bottom of the screen.
The message also goes into the `*Messages*' buffer.
\(In keyboard macros, that's all it does.)
+Return the message.

The first argument is a format control string, and the rest are data




reply via email to

[Prev in Thread] Current Thread [Next in Thread]