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

Previous Next

Full log

View this message in rfc822 format

From: help-debbugs <at> gnu.org (GNU bug Tracking System)
To: Juanma Barranquero <lekktu <at> gmail.com>
Cc: tracker <at> debbugs.gnu.org
Subject: bug#9259: closed (extra line in "unless" docstring?)
Date: Mon, 08 Aug 2011 13:54:02 +0000

[Message part 1 (text/plain, inline)]

Your message dated Mon, 8 Aug 2011 15:51:15 +0200
with message-id <CAAeL0ST2vdjT00toLVB9rAUATUSCLCigsGmBqvSS25K9TLdaog <at> mail.gmail.com>
and subject line Re: bug#9259: extra line in "unless" docstring?
has caused the GNU bug report #9259,
regarding extra line in "unless" docstring?
to be marked as done.

(If you believe you have received this mail in error, please contact
help-debbugs <at> gnu.org.)


-- 
9259: http://debbugs.gnu.org/cgi/bugreport.cgi?bug=9259
GNU Bug Tracking System
Contact help-debbugs <at> gnu.org with problems

[Message part 2 (message/rfc822, inline)]

From: jidanni <at> jidanni.org
To: bug-gnu-emacs <at> gnu.org
Subject: extra line in "unless" docstring?
Date: Mon, 08 Aug 2011 11:13:06 +0800

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.

[Message part 3 (message/rfc822, inline)]

From: Juanma Barranquero <lekktu <at> gmail.com>
To: jidanni <at> jidanni.org
Cc: 9259-done <at> debbugs.gnu.org
Subject: Re: bug#9259: extra line in "unless" docstring?
Date: Mon, 8 Aug 2011 15:51:15 +0200

> (unless COND BODY...)
>
> If COND yields nil, do BODY, else return nil. <--------what is this line doing here?

The same happens for `when', BTW.

It's not a bug. Most docstrings are written so the first line provides
a summary of the corresponding function/macro/special form/variable.
This makes the output of apropos more useful.

    Juanma

Previous Next

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