all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: Juri Linkov <juri@linkov.net>
To: Eli Zaretskii <eliz@gnu.org>
Cc: 61183@debbugs.gnu.org
Subject: bug#61183: 29.0.60; Add describe-repeat-maps to the manual
Date: Wed, 01 Feb 2023 20:06:08 +0200	[thread overview]
Message-ID: <86y1ph6z1r.fsf@mail.linkov.net> (raw)
In-Reply-To: <83y1pj3m4z.fsf@gnu.org> (Eli Zaretskii's message of "Mon, 30 Jan 2023 20:36:28 +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.





      parent reply	other threads:[~2023-02-01 18:06 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-01-30 17:19 bug#61183: 29.0.60; Add describe-repeat-maps to the manual Juri Linkov
2023-01-30 17:59 ` Eli Zaretskii
2023-01-30 18:10   ` Juri Linkov
2023-01-30 18:36     ` Eli Zaretskii
2023-01-31  9:45       ` Robert Pluim
2023-01-31 14:07         ` Eli Zaretskii
2023-02-01 18:06           ` Juri Linkov
2023-02-02 13:37             ` Eli Zaretskii
2023-02-01 18:06       ` Juri Linkov [this message]

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=86y1ph6z1r.fsf@mail.linkov.net \
    --to=juri@linkov.net \
    --cc=61183@debbugs.gnu.org \
    --cc=eliz@gnu.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this external index

	https://git.savannah.gnu.org/cgit/emacs.git
	https://git.savannah.gnu.org/cgit/emacs/org-mode.git

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.