Subject: bug#9259: closed (Re: bug#9259: extra line in "unless" docstring?)

From: [email-masked] (GNU bug Tracking System)
Date: Mon, 08 Aug 2011 13:54:02 +0000

Your bug report

#9259: extra line in "unless" docstring?

which was filed against the emacs package, has been closed.

The explanation is attached below, along with your original report.
If you require more details, please reply to [email-masked].

-- 
9259: http://debbugs.gnu.org/cgi/bugreport.cgi?bug=9259
GNU Bug Tracking System
Contact [email-masked] with problems

Subject: Re: bug#9259: extra line in "unless" docstring?
From: Juanma Barranquero <[email-masked]>
To: [email-masked]
Cc: [email-masked]
Date: Mon, 8 Aug 2011 15:51:15 +0200
List-Id: <debbugs-submit.debbugs.gnu.org>

> (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

Subject: extra line in "unless" docstring?
From: [email-masked]
To: [email-masked]
Date: Mon, 08 Aug 2011 11:13:06 +0800
List-Id: <debbugs-submit.debbugs.gnu.org>

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.