unofficial mirror of emacs-devel@gnu.org 
 help / color / mirror / code / Atom feed
From: martin rudalics <rudalics@gmx.at>
To: raffael.mancini@hcl-club.lu
Cc: emacs-devel@gnu.org
Subject: Re: Support for butterfly editing
Date: Fri, 08 Feb 2008 10:59:46 +0100	[thread overview]
Message-ID: <47AC2812.1050807@gmx.at> (raw)
In-Reply-To: <87prv848t0.wl%raffael.mancini@hcl-club.lu>

 >   "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/'.





  parent reply	other threads:[~2008-02-08  9:59 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2008-02-07 23:59 Support for butterfly editing raffael.mancini
2008-02-08  9:23 ` Jason Rumney
2008-02-08  9:59 ` martin rudalics [this message]
2008-12-28 23:52 ` Juri Linkov
2008-12-29  4:27   ` tomas

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://www.gnu.org/software/emacs/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=47AC2812.1050807@gmx.at \
    --to=rudalics@gmx.at \
    --cc=emacs-devel@gnu.org \
    --cc=raffael.mancini@hcl-club.lu \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/emacs.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).