From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: Stefan Monnier Newsgroups: gmane.emacs.devel Subject: Re: "What's This?" in Describe submenu Date: Tue, 23 Aug 2005 15:56:11 -0400 Message-ID: References: <4308398B.60401@gmx.at> <200508230008.j7N081514425@raven.dms.auburn.edu> <200508230456.j7N4u6x14879@raven.dms.auburn.edu> NNTP-Posting-Host: main.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset=us-ascii X-Trace: sea.gmane.org 1124827870 25435 80.91.229.2 (23 Aug 2005 20:11:10 GMT) X-Complaints-To: usenet@sea.gmane.org NNTP-Posting-Date: Tue, 23 Aug 2005 20:11:10 +0000 (UTC) Cc: rudalics@gmx.at, Luc Teirlinck , emacs-devel@gnu.org Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Tue Aug 23 22:11:05 2005 Return-path: Original-Received: from lists.gnu.org ([199.232.76.165]) by ciao.gmane.org with esmtp (Exim 4.43) id 1E7f4E-0006zx-Um for ged-emacs-devel@m.gmane.org; Tue, 23 Aug 2005 22:08:19 +0200 Original-Received: from localhost ([127.0.0.1] helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1E7f6d-0002Qo-Ke for ged-emacs-devel@m.gmane.org; Tue, 23 Aug 2005 16:10:47 -0400 Original-Received: from mailman by lists.gnu.org with tmda-scanned (Exim 4.43) id 1E7f5c-00022O-W6 for emacs-devel@gnu.org; Tue, 23 Aug 2005 16:09:45 -0400 Original-Received: from exim by lists.gnu.org with spam-scanned (Exim 4.43) id 1E7f5X-00020l-Nt for emacs-devel@gnu.org; Tue, 23 Aug 2005 16:09:41 -0400 Original-Received: from [199.232.76.173] (helo=monty-python.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1E7f5X-0001xZ-4J for emacs-devel@gnu.org; Tue, 23 Aug 2005 16:09:39 -0400 Original-Received: from [132.204.24.67] (helo=mercure.iro.umontreal.ca) by monty-python.gnu.org with esmtp (Exim 4.34) id 1E7etT-0001XS-Bl; Tue, 23 Aug 2005 15:57:11 -0400 Original-Received: from hidalgo.iro.umontreal.ca (hidalgo.iro.umontreal.ca [132.204.27.50]) by mercure.iro.umontreal.ca (Postfix) with ESMTP id D79FB2CF526; Tue, 23 Aug 2005 15:56:15 -0400 (EDT) Original-Received: from asado.iro.umontreal.ca (asado.iro.umontreal.ca [132.204.24.84]) by hidalgo.iro.umontreal.ca (Postfix) with ESMTP id A18934AC00A; Tue, 23 Aug 2005 15:56:11 -0400 (EDT) Original-Received: by asado.iro.umontreal.ca (Postfix, from userid 20848) id 92A5A506C; Tue, 23 Aug 2005 15:56:11 -0400 (EDT) Original-To: Eli Zaretskii In-Reply-To: (Eli Zaretskii's message of "Tue, 23 Aug 2005 22:34:57 +0300") User-Agent: Gnus/5.11 (Gnus v5.11) Emacs/22.0.50 (gnu/linux) X-DIRO-MailScanner-Information: Please contact the ISP for more information X-DIRO-MailScanner: Found to be clean X-DIRO-MailScanner-SpamCheck: n'est pas un polluriel, SpamAssassin (score=-4.844, requis 5, autolearn=not spam, AWL 0.06, BAYES_00 -4.90) X-MailScanner-From: monnier@iro.umontreal.ca 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:42365 Archived-At: > Now, I agree that what we say sounds not very clear (to say the least) > to a newbie, but I think we do mean to target newbies as well, and > that therefore we should work on making the doc string more > newbie-friendly. But I'm repeating myself... I've several times hesitated when writing a docstring: should it document the function or the command. The more typical problem is whether to refer to ARG, BEG, END or to \\[universal-argument], and the region. Maybe we should make i possible to provide two separate docstrings, one for the function and one for the command. Stefan