From mboxrd@z Thu Jan  1 00:00:00 1970
Path: news.gmane.org!not-for-mail
From: Luc Teirlinck <teirllm@dms.auburn.edu>
Newsgroups: gmane.emacs.devel
Subject: Re: "What's This?" in Describe submenu
Date: Tue, 23 Aug 2005 18:05:14 -0500 (CDT)
Message-ID: <200508232305.j7NN5EQ18152@raven.dms.auburn.edu>
References: <4308398B.60401@gmx.at> <E1E6zpF-0008Di-MQ@fencepost.gnu.org>
	<m3d5o62yiy.fsf@kfs-l.imdomain.dk> <uk6idwxww.fsf@gnu.org>
	<200508230008.j7N081514425@raven.dms.auburn.edu>
	<ufyt1wbzi.fsf@gnu.org>
	<200508230456.j7N4u6x14879@raven.dms.auburn.edu>
	<ud5o4wiou.fsf@gnu.org> <jwv64twa0py.fsf-monnier+emacs@gnu.org>
NNTP-Posting-Host: main.gmane.org
X-Trace: sea.gmane.org 1124838544 28855 80.91.229.2 (23 Aug 2005 23:09:04 GMT)
X-Complaints-To: usenet@sea.gmane.org
NNTP-Posting-Date: Tue, 23 Aug 2005 23:09:04 +0000 (UTC)
Cc: rudalics@gmx.at, eliz@gnu.org, emacs-devel@gnu.org
Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Wed Aug 24 01:08:59 2005
Return-path: <emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org>
Original-Received: from lists.gnu.org ([199.232.76.165])
	by ciao.gmane.org with esmtp (Exim 4.43)
	id 1E7hsW-0001Dk-IB
	for ged-emacs-devel@m.gmane.org; Wed, 24 Aug 2005 01:08:25 +0200
Original-Received: from localhost ([127.0.0.1] helo=lists.gnu.org)
	by lists.gnu.org with esmtp (Exim 4.43)
	id 1E7hwK-0000iH-2Y
	for ged-emacs-devel@m.gmane.org; Tue, 23 Aug 2005 19:12:20 -0400
Original-Received: from mailman by lists.gnu.org with tmda-scanned (Exim 4.43)
	id 1E7hvZ-0000Rj-76
	for emacs-devel@gnu.org; Tue, 23 Aug 2005 19:11:33 -0400
Original-Received: from exim by lists.gnu.org with spam-scanned (Exim 4.43)
	id 1E7hvU-0000QN-N2
	for emacs-devel@gnu.org; Tue, 23 Aug 2005 19:11:30 -0400
Original-Received: from [199.232.76.173] (helo=monty-python.gnu.org)
	by lists.gnu.org with esmtp (Exim 4.43) id 1E7hvU-0000Pa-IV
	for emacs-devel@gnu.org; Tue, 23 Aug 2005 19:11:28 -0400
Original-Received: from [131.204.53.104] (helo=manatee.dms.auburn.edu)
	by monty-python.gnu.org with esmtp (Exim 4.34)
	id 1E7hqq-0006GS-9e; Tue, 23 Aug 2005 19:06:40 -0400
Original-Received: from raven.dms.auburn.edu (raven.dms.auburn.edu [131.204.53.29])
	by manatee.dms.auburn.edu (8.12.10/8.12.10) with ESMTP id
	j7NN5Wqt001916; Tue, 23 Aug 2005 18:05:32 -0500 (CDT)
Original-Received: (from teirllm@localhost)
	by raven.dms.auburn.edu (8.11.7p1+Sun/8.11.7) id j7NN5EQ18152;
	Tue, 23 Aug 2005 18:05:14 -0500 (CDT)
X-Authentication-Warning: raven.dms.auburn.edu: teirllm set sender to
	teirllm@dms.auburn.edu using -f
Original-To: monnier@iro.umontreal.ca
In-reply-to: <jwv64twa0py.fsf-monnier+emacs@gnu.org> (message from Stefan
	Monnier on Tue, 23 Aug 2005 15:56:11 -0400)
X-BeenThere: emacs-devel@gnu.org
X-Mailman-Version: 2.1.5
Precedence: list
List-Id: "Emacs development discussions." <emacs-devel.gnu.org>
List-Unsubscribe: <http://lists.gnu.org/mailman/listinfo/emacs-devel>,
	<mailto:emacs-devel-request@gnu.org?subject=unsubscribe>
List-Archive: <http://lists.gnu.org/pipermail/emacs-devel>
List-Post: <mailto:emacs-devel@gnu.org>
List-Help: <mailto:emacs-devel-request@gnu.org?subject=help>
List-Subscribe: <http://lists.gnu.org/mailman/listinfo/emacs-devel>,
	<mailto:emacs-devel-request@gnu.org?subject=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:42371
Archived-At: <http://permalink.gmane.org/gmane.emacs.devel/42371>

Stefan Monnier wrote:

   I've several times hesitated when writing a docstring: should it document
   the function or the command.

I normally include paragraphs saying "When used interactively..." to
document the command and "When used from Lisp..." to document the
function.  But the fact remains that for complete newbies, the Emacs
manual usually provides better documentation than docstrings.

Sincerely,

Luc.