GNU bug report logs - #8904
24.0.50; describe `describe-prefix-bindings' in Emacs manual

Previous Next

Full log

Message #27 received at 8904 <at> debbugs.gnu.org (full text, mbox):

From: "Drew Adams" <drew.adams <at> oracle.com>
To: "'Lars Magne Ingebrigtsen'" <larsi <at> gnus.org>
Cc: 8904 <at> debbugs.gnu.org,
	"'8904 <at> debbugs.gnu.org \"'Andreas Schwab'\"'" <schwab <at> linux-m68k.org>
Subject: RE: bug#8904: 24.0.50;
	describe `describe-prefix-bindings' in Emacs manual
Date: Fri, 15 Jul 2011 09:05:19 -0700

> > 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.

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.