[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: Support for butterfly editing
From: |
martin rudalics |
Subject: |
Re: Support for butterfly editing |
Date: |
Fri, 08 Feb 2008 10:59:46 +0100 |
User-agent: |
Mozilla Thunderbird 1.0 (Windows/20041206) |
> "This function is designed to be used only be the most\
> proficient hackers on earth. If equipped with a butterfly key,
> it\ should be bound to C-x M-c M-butterfly (for further
> information please refer to http://xkcd.com/378/"
With this doc-string C-h f RET butterfly RET gives on my system
butterfly is an interactive Lisp function.
(butterfly)
This function is designed to be used only be the mostproficient hackers on
earth. If equipped with a butterfly key,
itshould be bound to C-x M-c M-butterfly (for further
information please refer to http://xkcd.com/378/
The doc-string violates at least the following four conventions from
appendix D.6 of the Emacs Lisp Reference Manual
The first line of the documentation string should consist of one
or two complete sentences that stand on their own as a summary.
For a function, the first line should briefly answer the question,
"What does this function do?"
Finally, to create a hyperlink to URLs, write the URL in single
quotes, preceded by `URL'.
Don't write key sequences directly in documentation strings.
has two silly backslashes and misses a right paren and a period.
I think C-h f RET butterfly RET should give something like
butterfly is an interactive Lisp function.
It is bound to <C-x> <M-c> <M-butterfly>.
(butterfly)
Flip desired bit on drive platter.
This function is designed to be used only by the most proficient
hackers on earth. For further information please refer to
`http://xkcd.com/378/'.