bug#4500: 23.1; dig-mode keymap in docstring

bug#4500: 23.1; dig-mode keymap in docstring

[Kevin Ryde]

[-- Attachment #1: Type: text/plain, Size: 305 bytes --]

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@zip.com.au>

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


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: dig.el.docstring-keymap.diff --]
[-- Type: text/x-diff, Size: 364 bytes --]

--- 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")

[-- Attachment #3: Type: text/plain, Size: 731 bytes --]


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=''

bug#4500: marked as done (23.1; dig-mode keymap in docstring)

[Emacs bug Tracking System]

[-- Attachment #1: Type: text/plain, Size: 883 bytes --]

Your message dated Sun, 20 Sep 2009 22:28:36 -0400
with message-id <jwvmy4pdoaz.fsf-monnier+emacsbugreports@gnu.org>
and subject line Re: bug#4500: 23.1; dig-mode keymap in docstring
has caused the Emacs bug report #4500,
regarding 23.1; dig-mode keymap in docstring
to be marked as done.

This means that you claim that the problem has been dealt with.
If this is not the case it is now your responsibility to reopen the
bug report if necessary, and/or fix the problem forthwith.

(NB: If you are a system administrator and have no idea what this
message is talking about, this may indicate a serious mail system
misconfiguration somewhere. Please contact owner@emacsbugs.donarmstrong.com
immediately.)


-- 
4500: http://emacsbugs.donarmstrong.com/cgi-bin/bugreport.cgi?bug=4500
Emacs Bug Tracking System
Contact owner@emacsbugs.donarmstrong.com with problems

[-- Attachment #2: Type: message/rfc822, Size: 3896 bytes --]

[-- Attachment #2.1.1: Type: text/plain, Size: 305 bytes --]

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@zip.com.au>

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


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2.1.2: dig.el.docstring-keymap.diff --]
[-- Type: text/x-diff, Size: 364 bytes --]

--- 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")

[-- Attachment #2.1.3: Type: text/plain, Size: 731 bytes --]


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=''

[-- Attachment #3: Type: message/rfc822, Size: 1923 bytes --]

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

> 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

bug#4500: 23.1; dig-mode keymap in docstring

[Juanma Barranquero]

On Mon, Sep 21, 2009 at 02:50, Kevin Ryde <user42@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

bug#4500: 23.1; dig-mode keymap in docstring

[Kevin Ryde]

Juanma Barranquero <lekktu@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.