unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
From: "Drew Adams" <drew.adams@oracle.com>
To: "'Lars Magne Ingebrigtsen'" <larsi@gnus.org>
Cc: 8904@debbugs.gnu.org,
	"'8904@debbugs.gnu.org \"'Andreas Schwab'\"'"
	<schwab@linux-m68k.org>
Subject: bug#8904: 24.0.50; describe `describe-prefix-bindings' in Emacs manual
Date: Fri, 15 Jul 2011 09:05:19 -0700	[thread overview]
Message-ID: <453F37B3AE1947E3B9F7ADFB99EE9D9C@us.oracle.com> (raw)
In-Reply-To: <m3zkkf1r5p.fsf@quimbies.gnus.org>

> > Lars, you need better doc for this command. ;-)  Seriously.
> 
> Or better bug reports.

It's not up to a bug report to teach what the function does or how it's
implemented or used.

This bug report was to say that this is not sufficiently documented.

> I've now added `describe-prefix-bindings' to the "Misc Help" 
> node in the Emacs manual.

Thanks.

Hopefully you added some of the info I provided that helped you understand, so
that other users will also understand.  Likewise for the doc string (and perhaps
for the text in the Elisp manual too).

The goal should be for someone like Lars to be able to understand this function
by reading its doc: what it's for, how to use it, what it does.






      reply	other threads:[~2011-07-15 16:05 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2011-06-20 17:08 bug#8904: 24.0.50; describe `describe-prefix-bindings' in Emacs manual Drew Adams
2011-07-15 14:21 ` Lars Magne Ingebrigtsen
2011-07-15 15:20   ` Andreas Schwab
2011-07-15 15:26     ` Lars Magne Ingebrigtsen
2011-07-15 15:40       ` Drew Adams
2011-07-15 15:48         ` Lars Magne Ingebrigtsen
2011-07-15 16:05           ` Drew Adams [this message]

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=453F37B3AE1947E3B9F7ADFB99EE9D9C@us.oracle.com \
    --to=drew.adams@oracle.com \
    --cc=8904@debbugs.gnu.org \
    --cc=larsi@gnus.org \
    --cc=schwab@linux-m68k.org \
    /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).