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

Message #10 received at 9259-done <at> debbugs.gnu.org (full text, mbox):

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