GNU bug report logs - #52870
Is displaying <menu-bar> bindings in describe-function useful?

Previous Next

Package: emacs;

Reported by: Stefan Kangas <stefan <at> marxist.se>

Date: Wed, 29 Dec 2021 12:42:01 UTC

Severity: wishlist

Fixed in version 29.1

Done: Lars Ingebrigtsen <larsi <at> gnus.org>

Bug is archived. No further changes may be made.

Full log


View this message in rfc822 format

From: Po Lu <luangruo <at> yahoo.com>
To: Lars Ingebrigtsen <larsi <at> gnus.org>
Cc: 52870 <at> debbugs.gnu.org, Eli Zaretskii <eliz <at> gnu.org>, Stefan Kangas <stefan <at> marxist.se>
Subject: bug#52870: Is displaying <menu-bar> bindings in describe-function useful?
Date: Sat, 15 Jan 2022 20:09:44 +0800
Lars Ingebrigtsen <larsi <at> gnus.org> writes:

> Eli Zaretskii <eliz <at> gnu.org> writes:
>
>>> What is your rationale for this?  Is it easier to accept if it is before
>>> the "Probably introduced" line?
>>
>> The rationale is that hardly anyone ever looks at the "Probably
>> introduced" line.  Before it is slightly better, but not good enough:
>> some doc strings are very long, so the menu-bar bindings will be
>> pushed too far.
>
> I think saying explictly
>
>   It can be invoked from the menu: "Help Menu" -> "Describe..."
>
> is a lot clearer (and helpful) for users than the current
>
> It is bound to C-h f, <help> f, <menu-bar> <help-menu> <describe>
> <describe-function>.
>
> Perhaps keeping it grouped with the binding info would be good, though.
> So:
>
> It is bound to C-h f and <help> f
> It can also be invoked from the menu: "Help Menu" -> "Describe" ...
>
> or something like that?

FWIW I think it would be a good idea to do something like this:

  It is bound to C-h f, <help> f, <menu-bar> <help-menu> <describe>
  <describe-function> (which means it can be invoked from the menu:
  "Help Menu" -> "Describe" ...).

Though I don't think I got the wording completely right there.




This bug report was last modified 3 years and 82 days ago.

Previous Next


GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.