completion-list-mode keymap in docstring

completion-list-mode keymap in docstring

[Kevin Ryde]

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

I'd be nice to have completion-list-mode-map shown in the
completion-list-mode docstring.  Despite using completion all the time I
only lately wanted to go beyond just pressing Ret, and hoped C-h m would
tell me all the keys (Ret is described in words), or at least such as
they are.

2008-01-23  Kevin Ryde  <user42@zip.com.au>

	* simple.el (completion-list-mode): Show full completion-list-mode-map
	in the docstring.
	

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

Index: simple.el
===================================================================
RCS file: /sources/emacs/emacs/lisp/simple.el,v
retrieving revision 1.898
diff -u -c -r1.898 simple.el
cvs diff: conflicting specifications of output style
*** simple.el	8 Jan 2008 20:44:35 -0000	1.898
--- simple.el	22 Jan 2008 22:33:09 -0000
***************
*** 5293,5299 ****
  Type \\<completion-list-mode-map>\\[choose-completion] in the completion list\
   to select the completion near point.
  Use \\<completion-list-mode-map>\\[mouse-choose-completion] to select one\
!  with the mouse."
    (interactive)
    (kill-all-local-variables)
    (use-local-map completion-list-mode-map)
--- 5293,5302 ----
  Type \\<completion-list-mode-map>\\[choose-completion] in the completion list\
   to select the completion near point.
  Use \\<completion-list-mode-map>\\[mouse-choose-completion] to select one\
!  with the mouse.
! 
! \\{completion-list-mode-map}"
! 
    (interactive)
    (kill-all-local-variables)
    (use-local-map completion-list-mode-map)

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

_______________________________________________
Emacs-devel mailing list
Emacs-devel@gnu.org
http://lists.gnu.org/mailman/listinfo/emacs-devel

RE: completion-list-mode keymap in docstring

[Drew Adams]

> I'd be nice to have completion-list-mode-map shown in the
> completion-list-mode docstring.  Despite using completion all the time I
> only lately wanted to go beyond just pressing Ret, and hoped C-h m would
> tell me all the keys (Ret is described in words), or at least such as
> they are.

FWIW (not an argument against) -

You can go to buffer *Completions* and hit `C-h b'.

Or you can use this (which I proposed that we add to Emacs):

(defun describe-keymap (keymap)
  "Describe bindings in KEYMAP, a variable whose value is a keymap.
Completion is available for the keymap name."
  (interactive
   (list (intern
          (completing-read
           "Keymap: " obarray
           (lambda (m) (and (boundp m) (keymapp (symbol-value m))))
           t nil 'variable-name-history))))
  (unless (and (symbolp keymap) (boundp keymap) (keymapp (symbol-value
keymap)))
    (error "`%S' is not a keymapp" keymap))
  (let ((name (symbol-name keymap)))
    (help-setup-xref (list #'describe-keymap keymap)
                     (interactive-p))
    (with-output-to-temp-buffer "*Help*"
      (princ name) (terpri)
      (princ (make-string (length name) ?-)) (terpri) (terpri)
      (princ (documentation-property keymap 'variable-documentation))
(terpri) (terpri)
      (princ (substitute-command-keys (concat "\\{" name "}"))))))

I bind that to `C-h M-k'. Then `C-h M-k co TAB RET' gives you a
user-friendly listing of `completion-list-mode-map'.

http://www.emacswiki.org/cgi-bin/wiki/HelpPlus