From mboxrd@z Thu Jan  1 00:00:00 1970
Path: main.gmane.org!not-for-mail
From: Colin Marquardt <c.marquardt@alcatel.de>
Newsgroups: gmane.emacs.help
Subject: Re: usability issue
Date: Thu, 16 Jan 2003 12:34:59 +0100
Organization: I'd rather call it chaos ...
Sender: help-gnu-emacs-bounces+gnu-help-gnu-emacs=m.gmane.org@gnu.org
Message-ID: <k8zfzrttjj0.fsf@slsf86.stgl.sel.alcatel.de>
References: <sfjel7qj5ww.fsf@quirm.cs.chalmers.se>
	<x5k7hhhqix.fsf@lola.goethe.zz> <87bs2tyk4x.fsf@wesley.springies.com>
	<mailman.58.1042029785.21513.help-gnu-emacs@gnu.org>
	<x5wulberxn.fsf@lola.goethe.zz>
	<m2el7dy4tj.fsf@coco.shootybangbang.com>
	<m23cntnzap.fsf@coco.shootybangbang.com>
NNTP-Posting-Host: main.gmane.org
Mime-Version: 1.0
Content-Type: text/plain; charset=us-ascii
X-Trace: main.gmane.org 1042717145 5782 80.91.224.249 (16 Jan 2003 11:39:05 GMT)
X-Complaints-To: usenet@main.gmane.org
NNTP-Posting-Date: Thu, 16 Jan 2003 11:39:05 +0000 (UTC)
Return-path: <help-gnu-emacs-bounces+gnu-help-gnu-emacs=m.gmane.org@gnu.org>
Original-Received: from monty-python.gnu.org ([199.232.76.173])
	by main.gmane.org with esmtp (Exim 3.35 #1 (Debian))
	id 18Z8MP-0001Ut-00
	for <gnu-help-gnu-emacs@m.gmane.org>; Thu, 16 Jan 2003 12:39:01 +0100
Original-Received: from localhost ([127.0.0.1] helo=monty-python.gnu.org)
	by monty-python.gnu.org with esmtp (Exim 4.10.13)
	id 18Z8JL-00020X-03
	for gnu-help-gnu-emacs@m.gmane.org; Thu, 16 Jan 2003 06:35:51 -0500
Original-Path: shelby.stanford.edu!newsfeed.stanford.edu!headwall.stanford.edu!fu-berlin.de!uni-berlin.de!news.stgl.sel.alcatel.DE!not-for-mail
Original-Newsgroups: gnu.emacs.help
Original-Lines: 12
Original-NNTP-Posting-Host: news.stgl.sel.alcatel.de (194.113.59.80)
Original-X-Trace: fu-berlin.de 1042716900 22803570 194.113.59.80 (16 [131051])
X-Disclaimer: Opinions expressed are not those of Alcatel.
User-Agent: Gnus/5.090012 (Oort Gnus v0.12) Emacs/21.2
 (sparc-sun-solaris2.8)
Cancel-Lock: sha1:VZHSEF68AsB62Mvt4B3WVp6p2Jw=
Cache-Post-Path: news.alcatel.de!unknown@slse6w.stgl.sel.alcatel.de
X-Cache: nntpcache 2.4.0b5 (see http://www.nntpcache.org/)
Original-Xref: shelby.stanford.edu gnu.emacs.help:109022
Original-To: help-gnu-emacs@gnu.org
X-BeenThere: help-gnu-emacs@gnu.org
X-Mailman-Version: 2.1b5
Precedence: list
List-Id: Users list for the GNU Emacs text editor <help-gnu-emacs.gnu.org>
List-Help: <mailto:help-gnu-emacs-request@gnu.org?subject=help>
List-Post: <mailto:help-gnu-emacs@gnu.org>
List-Subscribe: <http://mail.gnu.org/mailman/listinfo/help-gnu-emacs>,
	<mailto:help-gnu-emacs-request@gnu.org?subject=subscribe>
List-Archive: <http://mail.gnu.org/pipermail/help-gnu-emacs>
List-Unsubscribe: <http://mail.gnu.org/mailman/listinfo/help-gnu-emacs>,
	<mailto:help-gnu-emacs-request@gnu.org?subject=unsubscribe>
Errors-To: help-gnu-emacs-bounces+gnu-help-gnu-emacs=m.gmane.org@gnu.org
Xref: main.gmane.org gmane.emacs.help:5550
X-Report-Spam: http://spam.gmane.org/gmane.emacs.help:5550

jpw@shootybangbang.com (John Paul Wallington) writes:

> Your functions are neat.  Two nits: the first line of a doc string
> should "stand on it own" (ideally ending in a period) because
> `apropos' will return it in its output, and that the stray parens look
> funky because the convention is to cram all the closing parens
> together on the same line.

FWIW, M-x checkdoc can help to spot such things, and also develock.

Cheers,
  Colin