[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
bug#9259: extra line in "unless" docstring?
From: |
jidanni |
Subject: |
bug#9259: extra line in "unless" docstring? |
Date: |
Sun, 21 Aug 2011 06:15:14 +0800 |
>>>>> "CY" == Chong Yidong <cyd@stupidchicken.com> writes:
CY> jidanni@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.