GNU bug report logs - #9259
extra line in "unless" docstring?

Previous Next

Package: emacs;

Reported by: jidanni <at> jidanni.org

Date: Mon, 8 Aug 2011 04:58:01 UTC

Severity: normal

Done: Juanma Barranquero <lekktu <at> gmail.com>

Bug is archived. No further changes may be made.

Full log

View this message in rfc822 format

From: jidanni <at> jidanni.org
To: cyd <at> stupidchicken.com
Cc: 9259 <at> debbugs.gnu.org
Subject: bug#9259: extra line in "unless" docstring?
Date: Sun, 21 Aug 2011 06:15:14 +0800

>>>>> "CY" == Chong Yidong <cyd <at> stupidchicken.com> writes:
CY> jidanni <at> jidanni.org writes:

>> unless is a Lisp macro in `subr.el'.
>> 
>> (unless COND BODY...)
>> 
>> If COND yields nil, do BODY, else return nil. <--------what is this
>> line doing here?
>> When COND yields nil, eval BODY forms sequentially and return
>> value of last one, or nil if there are none.

CY> It's the one-line summary of the function.  Every docstring has one.

Well e.g., man pages have headers "SUMMARY" etc. separating the different
parts. If the rendering jammed them all together it would look bad.

Even in debian apt there is indentation:

Description: Web browser based on Firefox
 Iceweasel is Firefox, rebranded. It is a powerful, extensible web browser with
 support for modern web application technologies.
This bug report was last modified 13 years and 361 days ago.

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.