describe-mode should mention the .el file of the mode

describe-mode should mention the .el file of the mode

[Dan Jacobson]

We hit C-h m, describe-mode, on your average mode:
The major mode is described first.
For minor modes, see following pages.

[average] mode:
bla bla bla

Well, aren't you going to tell us what .el file this mode is defined
in, and make it a clickable link so one can go straight to see the
file?

Re: describe-mode should mention the .el file of the mode

[Kevin Rodgers]

Dan Jacobson wrote:
 > We hit C-h m, describe-mode, on your average mode:
 > The major mode is described first.
 > For minor modes, see following pages.
 >
 > [average] mode:
 > bla bla bla
 >
 > Well, aren't you going to tell us what .el file this mode is defined
 > in, and make it a clickable link so one can go straight to see the
 > file?

No, that would be overkill.  If you want to see the source code of the
major mode function, type `C-h v major-mode', click on the function
name, then click on the file name.  You suggestion would only save the
user 1 mouse click, hardly worth it.

-- 
Kevin Rodgers

Re: describe-mode should mention the .el file of the mode

[Dan Jacobson]

K> No, that would be overkill.  If you want to see the source code of the
K> major mode function, type `C-h v major-mode', click on the function
K> name, then click on the file name.  You suggestion would only save the
K> user 1 mouse click, hardly worth it.

We examine the differences,

< text-mode is an interactive compiled Lisp function in `textmodes/text-mode'.
< (text-mode)
---
> The major mode is described first.
> For minor modes, see following pages.

> Text mode:


< makefile-mode is an interactive compiled Lisp function in `make-mode'.
< (makefile-mode)
---
> The major mode is described first.
> For minor modes, see following pages.

> Makefile mode:

As we see, with the present C-h m, we are denied the juicy link.
Instead Mr. Rodgers proposes the user translate "Makefile" into
"makefile-mode", "Text" into "text-mode", and hit some more keys, for
fear of overkill.

Re: describe-mode should mention the .el file of the mode

[Kevin Rodgers]

Dan Jacobson wrote:
 > K> No, that would be overkill.  If you want to see the source code of the
 > K> major mode function, type `C-h v major-mode', click on the function
 > K> name, then click on the file name.  You suggestion would only save the
 > K> user 1 mouse click, hardly worth it.
 >
 > We examine the differences,

Between the output of `C-h m' in Text mode and in Makefile mode --
why?

...

 > As we see, with the present C-h m, we are denied the juicy link.
 > Instead Mr. Rodgers proposes the user translate "Makefile" into
 > "makefile-mode", "Text" into "text-mode", and hit some more keys, for
 > fear of overkill.

No, I propose that the user let Emacs translate `major-mode' into
`text-mode' or `makefile-mode' for him/her.  But my claim that the
difference between your request and this approach was only 1 mouse
failed to consider the 10 characters in "major-mode".  Like this:

(defun describe-major-mode-function ()
   "*Display the full documentation of the `major-mode' function."
   (interactive)
   (describe-function major-mode))

-- 
Kevin Rodgers