From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: "Juanma Barranquero" Newsgroups: gmane.emacs.devel Subject: message's docstring Date: Sun, 12 Nov 2006 01:11:02 +0100 Message-ID: NNTP-Posting-Host: main.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset=UTF-8; format=flowed Content-Transfer-Encoding: 7bit X-Trace: sea.gmane.org 1163290354 23648 80.91.229.2 (12 Nov 2006 00:12:34 GMT) X-Complaints-To: usenet@sea.gmane.org NNTP-Posting-Date: Sun, 12 Nov 2006 00:12:34 +0000 (UTC) Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Sun Nov 12 01:12:32 2006 Return-path: Envelope-to: ged-emacs-devel@m.gmane.org Original-Received: from lists.gnu.org ([199.232.76.165]) by ciao.gmane.org with esmtp (Exim 4.43) id 1Gj2xY-0002ws-GG for ged-emacs-devel@m.gmane.org; Sun, 12 Nov 2006 01:12:28 +0100 Original-Received: from localhost ([127.0.0.1] helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1Gj2xX-0004aD-QV for ged-emacs-devel@m.gmane.org; Sat, 11 Nov 2006 19:12:27 -0500 Original-Received: from mailman by lists.gnu.org with tmda-scanned (Exim 4.43) id 1Gj2xL-0004a8-4a for emacs-devel@gnu.org; Sat, 11 Nov 2006 19:12:15 -0500 Original-Received: from exim by lists.gnu.org with spam-scanned (Exim 4.43) id 1Gj2xH-0004Zh-5J for emacs-devel@gnu.org; Sat, 11 Nov 2006 19:12:14 -0500 Original-Received: from [199.232.76.173] (helo=monty-python.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1Gj2xG-0004Ze-UN for emacs-devel@gnu.org; Sat, 11 Nov 2006 19:12:10 -0500 Original-Received: from [199.232.41.67] (helo=mx20.gnu.org) by monty-python.gnu.org with esmtps (TLS-1.0:RSA_AES_256_CBC_SHA:32) (Exim 4.52) id 1Gj2xG-0007HA-S5 for emacs-devel@gnu.org; Sat, 11 Nov 2006 19:12:10 -0500 Original-Received: from [64.233.166.179] (helo=py-out-1112.google.com) by mx20.gnu.org with esmtp (Exim 4.52) id 1Gj2xG-0007jq-5a for emacs-devel@gnu.org; Sat, 11 Nov 2006 19:12:10 -0500 Original-Received: by py-out-1112.google.com with SMTP id p76so495021pyb for ; Sat, 11 Nov 2006 16:11:06 -0800 (PST) DomainKey-Signature: a=rsa-sha1; q=dns; c=nofws; s=beta; d=gmail.com; h=received:message-id:date:from:to:subject:mime-version:content-type:content-transfer-encoding:content-disposition; b=UXda5pJ3GDNfNJtlhgPQUIZWNuL4IFyt8ciNnVxrNqPNOJJOIzaC3SCcK7T/tth4q29rHx6jJw70S69n/I0P3PxhEIT28JQY+2pWPvS6ix90NG0EtdB+c0ufbEOsjDyGTiBHmqd76nEgHxrIhwzWRczqnZSEzGHIyeWe7udNiyg= Original-Received: by 10.35.9.15 with SMTP id m15mr7087211pyi.1163290262913; Sat, 11 Nov 2006 16:11:02 -0800 (PST) Original-Received: by 10.35.95.18 with HTTP; Sat, 11 Nov 2006 16:11:02 -0800 (PST) Original-To: "emacs- devel" Content-Disposition: inline X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.5 Precedence: list List-Id: "Emacs development discussions." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Original-Sender: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Errors-To: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Xref: news.gmane.org gmane.emacs.devel:62086 Archived-At: 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