GNU bug report logs - #4500
23.1; dig-mode keymap in docstring

Previous Next

To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 4500 in the body.
You can then email your comments to 4500 AT debbugs.gnu.org in the normal way.

Toggle the display of automated, internal messages from the tracker.

Message #5 received at submit <at> emacsbugs.donarmstrong.com (full text, mbox):

From: Kevin Ryde <user42 <at> zip.com.au>
To: bug-gnu-emacs <at> gnu.org
Subject: 23.1; dig-mode keymap in docstring
Date: Mon, 21 Sep 2009 10:50:28 +1000

[Message part 1 (text/plain, inline)]

I did a C-h m in an M-x dig mode buffer and hoped it might show the keys
available to do stuff.  There isn't anything to do in fact, but if the
keymap were in the docstring it'd tell me that :-).

2009-09-21  Kevin Ryde  <user42 <at> zip.com.au>

	* net/dig.el (dig-mode): Show dig-mode-map in the docstring.

[dig.el.docstring-keymap.diff (text/x-diff, inline)]

--- dig.el.~1.7.~	2009-09-21 10:46:28.000000000 +1000
+++ dig.el	2009-09-21 10:46:56.000000000 +1000
@@ -137,7 +137,8 @@
   (define-key dig-mode-map "q" 'dig-exit))
 
 (defun dig-mode ()
-  "Major mode for displaying dig output."
+  "Major mode for displaying dig output.
+\\{dig-mode-map}"
   (interactive)
   (kill-all-local-variables)
   (setq mode-name "dig")

[Message part 3 (text/plain, inline)]

In GNU Emacs 23.1.1 (i486-pc-linux-gnu, GTK+ Version 2.16.5)
 of 2009-08-03 on raven, modified by Debian
configured using `configure  '--build=i486-linux-gnu' '--host=i486-linux-gnu' '--prefix=/usr' '--sharedstatedir=/var/lib' '--libexecdir=/usr/lib' '--localstatedir=/var/lib' '--infodir=/usr/share/info' '--mandir=/usr/share/man' '--with-pop=yes' '--enable-locallisppath=/etc/emacs23:/etc/emacs:/usr/local/share/emacs/23.1/site-lisp:/usr/local/share/emacs/site-lisp:/usr/share/emacs/23.1/site-lisp:/usr/share/emacs/site-lisp:/usr/share/emacs/23.1/leim' '--with-x=yes' '--with-x-toolkit=gtk' '--with-toolkit-scroll-bars' 'build_alias=i486-linux-gnu' 'host_alias=i486-linux-gnu' 'CFLAGS=-DDEBIAN -g -O2' 'LDFLAGS=-g' 'CPPFLAGS=''

Message #10 received at 4500-done <at> emacsbugs.donarmstrong.com (full text, mbox):

From: Stefan Monnier <monnier <at> iro.umontreal.ca>
To: Kevin Ryde <user42 <at> zip.com.au>
Subject: Re: bug#4500: 23.1; dig-mode keymap in docstring
Date: Sun, 20 Sep 2009 22:28:36 -0400

> I did a C-h m in an M-x dig mode buffer and hoped it might show the keys
> available to do stuff.  There isn't anything to do in fact, but if the
> keymap were in the docstring it'd tell me that :-).

I've installed another patch that uses define-derived-mode instead.


        Stefan

Message #15 received at 4500 <at> emacsbugs.donarmstrong.com (full text, mbox):

From: Juanma Barranquero <lekktu <at> gmail.com>
To: Kevin Ryde <user42 <at> zip.com.au>
Cc: 4500 <at> debbugs.gnu.org
Subject: Re: bug#4500: 23.1; dig-mode keymap in docstring
Date: Mon, 21 Sep 2009 11:59:40 +0200

On Mon, Sep 21, 2009 at 02:50, Kevin Ryde <user42 <at> zip.com.au> wrote:

> There isn't anything to do in fact, but if the
> keymap were in the docstring it'd tell me that :-).

That's quite ugly :(

    Juanma

Message #20 received at 4500 <at> emacsbugs.donarmstrong.com (full text, mbox):

From: Kevin Ryde <user42 <at> zip.com.au>
To: Juanma Barranquero <lekktu <at> gmail.com>
Cc: 4500 <at> debbugs.gnu.org
Subject: Re: bug#4500: 23.1; dig-mode keymap in docstring
Date: Tue, 22 Sep 2009 08:53:01 +1000

Juanma Barranquero <lekktu <at> gmail.com> writes:
>
> That's quite ugly :(

An artifact of `suppress-keymap' I suppose.  Maybe the keymap display
stuff could recognise the bindings that func applies and show something
nicer.

Previous Next

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