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

Previous Next

Full log

Message #35 received at 52870 <at> debbugs.gnu.org (full text, mbox):

From: Lars Ingebrigtsen <larsi <at> gnus.org>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: 52870 <at> debbugs.gnu.org, Stefan Kangas <stefan <at> marxist.se>
Subject: Re: bug#52870: Is displaying <menu-bar> bindings in
 describe-function useful?
Date: Sat, 15 Jan 2022 11:09:58 +0100

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?

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

Previous Next

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