GNU bug report logs - #61183
29.0.60; Add describe-repeat-maps to the manual

Previous Next

Full log

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

From: Juri Linkov <juri <at> linkov.net>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: 61183 <at> debbugs.gnu.org
Subject: Re: bug#61183: 29.0.60; Add describe-repeat-maps to the manual
Date: Wed, 01 Feb 2023 20:06:08 +0200

>> >> +navigate @code{next-error} matches, @kbd{C-x ] ] [ [} to navigate
>> >> +through pages, and other listed in @code{describe-repeat-maps}.
>> >
>> > "and other commands", I presume?
>>
>> This is what I already tried, but noticed that it's talking about
>> key sequences.  But "other key sequences" looks awkward too.
>
> "Other key sequences" sounds OK to me.
>
>> > Also, saying that commands are "listed in" a function sounds
>> > awkwardly; I guess you meant in the window shown by
>> > describe-repeat-maps instead?
>>
>> Maybe simply "listed by describe-repeat-maps"?
>
> Also works.

Pushed.

>> Its output is easy to understand for anyone who uses this feature
>> and just wants to check what commands are already supported.
>
> That's not the correct criterion for judging documentation, definitely
> not when the manual is concerned.  The manual should be clear enough
> to explain the command's effect even to someone who reads about
> repeated commands for the first time.
>
> And even if you only consider experienced users, how can a user
> understand that these commands support repeating?  Which part(s) of
> that buffer say that in terns that are clear enough?  A naïve reader
> of the buffer will just see a list of commands and their bindings,
> preceded by a sentence whose intent is hard to understand without some
> background in Emacs keymaps.

Maybe this should be explained in the docstring of describe-repeat-maps.

Previous Next

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