From: Stefan Kangas <stefankangas@gmail.com>
To: Eli Zaretskii <eliz@gnu.org>
Cc: Emacs developers <emacs-devel@gnu.org>
Subject: Re: master 5b1109394c: ; * lisp/edmacro.el: Minor doc fixes.
Date: Thu, 23 Jun 2022 11:15:43 +0200 [thread overview]
Message-ID: <CADwFkmkpEeuPW1J6Z=E=usb3__VvdNX-DfWYUw7XwW-otmqu5Q@mail.gmail.com> (raw)
In-Reply-To: <83a6a4exzk.fsf@gnu.org>
Eli Zaretskii <eliz@gnu.org> writes:
> Again, that's not what I asked. I asked whether _all_ references to
> these keys in doc strings should be quoted.
If these are keybindings, then yes. I think we have cases where RET
does not refer to a keybinding. In such cases, it should not be
tagged.
> If the answer is YES, I
> guess that means we will soon see changes to that effect all over the
> place in the existing code, and we should comment on patches which
> don't do that to tell the contributors to do so. Right?
I think we should ask contributors to do that, yes. I'd encourage
everyone to tag keybindings as such with substitute-command-keys when
they run into them.
However, it would be nice if we thought of more clear conventions in
these common cases:
1. M-x some-prompting-command RET
2. M-x some-prompting-command some-user-input RET
Should there be a non-fontified space between the command name and RET
in (1) or should they have the same face? Should "some-user-input" in
(2) have the same face as a keybinding, or should we have a separate
face (for example: no face at all by convention) for replies to
prompts?
prev parent reply other threads:[~2022-06-23 9:15 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-06-22 14:05 master 5b1109394c: ; * lisp/edmacro.el: Minor doc fixes Eli Zaretskii
2022-06-22 14:26 ` Lars Ingebrigtsen
2022-06-22 15:57 ` Eli Zaretskii
2022-06-22 20:17 ` Stefan Kangas
2022-06-23 5:43 ` Eli Zaretskii
2022-06-23 9:15 ` Stefan Kangas [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
List information: https://www.gnu.org/software/emacs/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to='CADwFkmkpEeuPW1J6Z=E=usb3__VvdNX-DfWYUw7XwW-otmqu5Q@mail.gmail.com' \
--to=stefankangas@gmail.com \
--cc=eliz@gnu.org \
--cc=emacs-devel@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 public inbox
https://git.savannah.gnu.org/cgit/emacs.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).