* bug#9259: extra line in "unless" docstring?
@ 2011-08-08 3:13 jidanni
2011-08-08 13:51 ` Juanma Barranquero
` (2 more replies)
0 siblings, 3 replies; 4+ messages in thread
From: jidanni @ 2011-08-08 3:13 UTC (permalink / raw)
To: 9259
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.
^ permalink raw reply [flat|nested] 4+ messages in thread
* bug#9259: extra line in "unless" docstring?
2011-08-08 3:13 bug#9259: extra line in "unless" docstring? jidanni
@ 2011-08-08 13:51 ` Juanma Barranquero
2011-08-20 21:48 ` Chong Yidong
2011-08-20 22:15 ` jidanni
2 siblings, 0 replies; 4+ messages in thread
From: Juanma Barranquero @ 2011-08-08 13:51 UTC (permalink / raw)
To: jidanni; +Cc: 9259-done
> (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
^ permalink raw reply [flat|nested] 4+ messages in thread
* bug#9259: extra line in "unless" docstring?
2011-08-08 3:13 bug#9259: extra line in "unless" docstring? jidanni
2011-08-08 13:51 ` Juanma Barranquero
@ 2011-08-20 21:48 ` Chong Yidong
2011-08-20 22:15 ` jidanni
2 siblings, 0 replies; 4+ messages in thread
From: Chong Yidong @ 2011-08-20 21:48 UTC (permalink / raw)
To: jidanni; +Cc: 9259
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.
It's the one-line summary of the function. Every docstring has one.
^ permalink raw reply [flat|nested] 4+ messages in thread
* bug#9259: extra line in "unless" docstring?
2011-08-08 3:13 bug#9259: extra line in "unless" docstring? jidanni
2011-08-08 13:51 ` Juanma Barranquero
2011-08-20 21:48 ` Chong Yidong
@ 2011-08-20 22:15 ` jidanni
2 siblings, 0 replies; 4+ messages in thread
From: jidanni @ 2011-08-20 22:15 UTC (permalink / raw)
To: cyd; +Cc: 9259
>>>>> "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.
^ permalink raw reply [flat|nested] 4+ messages in thread
end of thread, other threads:[~2011-08-20 22:15 UTC | newest]
Thread overview: 4+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2011-08-08 3:13 bug#9259: extra line in "unless" docstring? jidanni
2011-08-08 13:51 ` Juanma Barranquero
2011-08-20 21:48 ` Chong Yidong
2011-08-20 22:15 ` jidanni
Code repositories for project(s) associated with this external index
https://git.savannah.gnu.org/cgit/emacs.git
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.