all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: "Juanma Barranquero" <lekktu@gmail.com>
Subject: message's docstring
Date: Sun, 12 Nov 2006 01:11:02 +0100	[thread overview]
Message-ID: <f7ccd24b0611111611q1a6767b5if0b1a0d21f8b057c@mail.gmail.com> (raw)

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	other threads:[~2006-11-12  0:11 UTC|newest]

Thread overview: 11+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2006-11-12  0:11 Juanma Barranquero [this message]
2006-11-12 10:16 ` message's docstring David Kastrup
2006-11-12 12:08   ` Juanma Barranquero
2006-11-12 12:17     ` David Kastrup
2006-11-12 12:20       ` Juanma Barranquero
2006-11-12 12:29         ` David Kastrup
2006-11-12 12:42           ` Juanma Barranquero
2006-11-13  9:43           ` Richard Stallman
2006-11-13 18:36   ` Kevin Rodgers
2006-11-13 19:04     ` Juanma Barranquero
2006-11-12 21:12 ` Richard Stallman

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=f7ccd24b0611111611q1a6767b5if0b1a0d21f8b057c@mail.gmail.com \
    --to=lekktu@gmail.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this external index

	https://git.savannah.gnu.org/cgit/emacs.git
	https://git.savannah.gnu.org/cgit/emacs/org-mode.git

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.