bug#11202: 24.0.93; shell.el: Documentation for M-x shell sometimes shows wrong keybinding for describe-mode

bug#11202: 24.0.93; shell.el: Documentation for M-x shell sometimes shows wrong keybinding for describe-mode

[David Röthlisberger]

If I invoke 'M-x describe-function shell' when I am already in help-mode, the last sentence reads:

> (Type h in the shell buffer for a list of commands.)

(Normally --if describe-function is invoked from outside of help-mode-- it would read "C-h m" instead of "h".)

Patch below. Would you like me to provide a similar patch for all instances of "\\[describe-mode]" in the lisp directory?

Kind regards,
Dave.


From: David Rothlisberger <david@rothlis.net>
Date: Sun, 8 Apr 2012 13:50:28 +0100
Subject: [PATCH] * shell.el: Correct keybinding for `describe-mode' in
 `shell' docstring.

---
 lisp/shell.el |    2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/lisp/shell.el b/lisp/shell.el
index 7c5ce49..a9e2113 100644
--- a/lisp/shell.el
+++ b/lisp/shell.el
@@ -607,7 +607,7 @@ (defun shell (&optional buffer)
 and controlling the subjobs of the shell.  See `shell-mode'.
 See also the variable `shell-prompt-pattern'.
 
-To specify a coding system for converting non-ASCII characters
+\\<shell-mode-map>To specify a coding system for converting non-ASCII characters
 in the input and output to the shell, use \\[universal-coding-system-argument]
 before \\[shell].  You can also specify this with \\[set-buffer-process-coding-system]
 in the shell buffer, after you start the shell.
-- 
1.7.9.2

bug#11202: Acknowledgement (24.0.93; shell.el: Documentation for M-x shell sometimes shows wrong keybinding for describe-mode)

[David Röthlisberger]

Note that this problem manifests itself more often than the original report implies.

In the *Help* buffer for `shell', if I navigate to the help for any of the linked functions or variables, then click the `[back]' link, the help text for `shell' has changed to the incorrect text as per the original report.

bug#11202: 24.0.93; shell.el: Documentation for M-x shell sometimes shows wrong keybinding for describe-mode

[Stefan Monnier]

> If I invoke 'M-x describe-function shell' when I am already in
> help-mode, the last sentence reads:
>> (Type h in the shell buffer for a list of commands.)

Yup, that's a bug.

> Patch below. Would you like me to provide a similar patch for all instances
> of "\\[describe-mode]" in the lisp directory?

Such a patch would be very welcome, yes.  Even better would be some way
to detect the problem automatically (maybe from checkdoc?).


        Stefan

bug#11202: 24.0.93; shell.el: Documentation for M-x shell sometimes shows wrong keybinding for describe-mode

[Lars Ingebrigtsen]

David Röthlisberger <david@rothlis.net> writes:

> If I invoke 'M-x describe-function shell' when I am already in
> help-mode, the last sentence reads:
>
>> (Type h in the shell buffer for a list of commands.)
>
> (Normally --if describe-function is invoked from outside of
> help-mode-- it would read "C-h m" instead of "h".)
>
> Patch below.

I've now applied it to Emacs 27.

> Would you like me to provide a similar patch for all
> instances of "\\[describe-mode]" in the lisp directory?

This was apparently not done, but is perhaps best left to a new bug
report, if needed.

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