From: "Clément Pit-Claudel" <cpitclaudel@gmail.com>
To: Eli Zaretskii <eliz@gnu.org>
Cc: rpluim@gmail.com, 37785@debbugs.gnu.org
Subject: bug#37785: [PATCH] Add a way to disable substitution of command keys in help strings
Date: Thu, 17 Oct 2019 09:47:52 -0400 [thread overview]
Message-ID: <1eecb79e-3087-8c49-5c80-d8a7f619a157@gmail.com> (raw)
In-Reply-To: <83h847bjl5.fsf@gnu.org>
On 2019-10-17 09:13, Eli Zaretskii wrote:
>> From: Clément Pit-Claudel <cpitclaudel@gmail.com>
>> Date: Thu, 17 Oct 2019 08:01:58 -0400
>> Cc: 37785@debbugs.gnu.org
>>
>>> Full stops at the end of sentences. Also, I think I prefer Eli's name,
>>> mainly because yours combines 'show' with 'inhibit', which I find
>>> jarring, and because Eli's contains 'help-echo', which mirrors the
>>> name of the affected property.
>>
>> The property affects more than help-echo strings: it affects anything that is fed to show-help-function. That's why I changed the name; WDYT?
>
> But show-help-function is for showing help-echo, is it not?
That's true, and my explanation wasn't very good. I'm working off of this commit:
commit 5f5fe275ec54194a9293690ffee3d425026ac14b
Author: Paul Eggert <eggert@cs.ucla.edu>
Date: Sun Aug 2 14:55:15 2015 -0700
Treat help strings like other doc strings
* doc/lispref/text.texi (Special Properties), etc/NEWS: Document this.
* lisp/epa.el (epa--select-keys): Remove no-longer-needed calls to
substitute-command-keys.
* src/keyboard.c (show_help_echo, parse_menu_item): Call
substitute-command-keys on the help string before displaying it.
It adds Fsubstitute_command_keys in two places: show_help_echo and parse_menu_item. The patch I sent makes both of these calls conditional, so calling the variable help-echo-inhibit-substitutions isn't right.
That commit added this NEWS entry:
+** show-help-function's arg is converted via substitute-command-keys
+before being passed to the function. Help strings, help-echo
+properties, etc. can therefore contain command key escapes and
+quotation marks.
But in fact show-help-function's arg being converted only affect help-echo properties; it's the change to parse_menu_item that does the rest.
I can either:
* Change the name to something like help-string-inhibit-substitutions.
* Restrict the patch to the argument of show-help-function, and rename the variable to help-echo-inhibit-substitutions.
Let me know,
Clément.
next prev parent reply other threads:[~2019-10-17 13:47 UTC|newest]
Thread overview: 12+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-10-17 1:41 bug#37785: [PATCH] Add a way to disable substitution of command keys in help strings Clément Pit-Claudel
2019-10-17 9:44 ` Robert Pluim
2019-10-17 12:01 ` Clément Pit-Claudel
2019-10-17 13:13 ` Eli Zaretskii
2019-10-17 13:47 ` Clément Pit-Claudel [this message]
2019-10-17 14:06 ` Eli Zaretskii
2019-10-17 15:53 ` Clément Pit-Claudel
2019-10-17 17:18 ` Eli Zaretskii
2019-10-19 20:35 ` Clément Pit-Claudel
2019-10-20 12:08 ` Eli Zaretskii
2019-10-21 1:53 ` Clément Pit-Claudel
2019-10-17 15:06 ` Robert Pluim
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=1eecb79e-3087-8c49-5c80-d8a7f619a157@gmail.com \
--to=cpitclaudel@gmail.com \
--cc=37785@debbugs.gnu.org \
--cc=eliz@gnu.org \
--cc=rpluim@gmail.com \
/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.