\\{foo-mode-map}

\\{foo-mode-map}

[Lars Ingebrigtsen]

`C-h m' displays the doc string of the current major mode.  It does not
output the mode map -- unless the programmer has put \\{foo-mode-map}
into the doc string.  Many modes do not, which means that the user has
to rely on `C-h b' to try to find out what the available commands are.
Which isn't optimal.

I think it might be a good idea to change `C-h m' so that it always
outputs the major mode map.  That is, if the doc string already does so,
it shouldn't output it again, but if the doc string doesn't, then output
the major mode map after the doc string.

And then we could stop encouraging that these doc strings include
\\{foo-mode-map}.

Any opinions?

-- 
(domestic pets only, the antidote for overdose, milk.)
   bloggy blog: http://lars.ingebrigtsen.no

Re: \\{foo-mode-map}

[Stefan Monnier]

> `C-h m' displays the doc string of the current major mode.  It does not
> output the mode map -- unless the programmer has put \\{foo-mode-map}
> into the doc string.  Many modes do not, which means that the user has
> to rely on `C-h b' to try to find out what the available commands are.
> Which isn't optimal.

IIRC `define-derived-mode` adds that `\\{foo-mode-map}` thingy unless
there are already some `\\[...]` in the docstring.

> And then we could stop encouraging that these doc strings include
> \\{foo-mode-map}.

We definitely don't need to do that (better encourage the use of
`define-derived-mode` instead).


        Stefan

Re: \\{foo-mode-map}

[Lars Ingebrigtsen]

Stefan Monnier <monnier@iro.umontreal.ca> writes:

> IIRC `define-derived-mode` adds that `\\{foo-mode-map}` thingy unless
> there are already some `\\[...]` in the docstring.

Oh yeah, so it does.  I wonder why I seem to be encountering so many
major modes without a keymap, then?  I'll have to pay closer attention
the next time it happens.

It could just be from old modes that haven't been converted, though.

-- 
(domestic pets only, the antidote for overdose, milk.)
   bloggy blog: http://lars.ingebrigtsen.no