From: Dmitry Gutov <dgutov@yandex.ru>
To: Paul Eggert <eggert@cs.ucla.edu>, emacs-devel@gnu.org
Subject: Re: Escaping quotes in docstrings, Was: A simple solution to "Upcoming loss of usability ..."
Date: Mon, 6 Jul 2015 15:07:34 +0300 [thread overview]
Message-ID: <559A6F86.2080809@yandex.ru> (raw)
In-Reply-To: <559A1C54.5030405@cs.ucla.edu>
On 07/06/2015 09:12 AM, Paul Eggert wrote:
> I've done that, and have discovered a couple of problems.
Thank you.
> First, a doc string that contains \[foo] is supposed to generate a key
> description for 'foo', derived by calling (key-description 'foo). But
> key-description can return a string that contains quote marks, and in
> general some of them should be escaped and others should not be. It's
> not clear to me whether both possibilities can occur in doc strings, but
> the situation is worrisome.
Why not put `escaped' (or rename that `translated', maybe) on those
generated regions as well?
> Second, and more generally, the overall approach seems error prone. It
> asks programmers to mark every quote character that should not be
> transformed. But characters can come from many different sources, and
> it's hard to keep track of each place that can insert user data of some
> sort.
So far I've only seen a few places of complication nearby: key
translations, keymap translations, and the escaping mechanism itself.
The rest of them will likely have to be handled in
substitute-command-keys anyway, somehow.
> In contrast, it's easy to find grave accents in doc strings, to
> fix the relative few that aren't already transformed automatically, and
> to not worry about user data.
If we find it hard to expose this data to Lisp, it will make the output
presentation less flexible, and could indicate an overall problem in our
docstring generation (we don't know all the possible sources the
characters can come from? that's not very good).
By the way, when doing translation in Lisp, instead of using
help-mode-finish, we can instead examine all the functions that generate
help buffers for Lisp stuff, and translate only the docstrings, when
they are being inserted.
next prev parent reply other threads:[~2015-07-06 12:07 UTC|newest]
Thread overview: 51+ messages / expand[flat|nested] mbox.gz Atom feed top
2015-06-25 14:59 A simple solution to "Upcoming loss of usability ..." Oleh Krehel
2015-06-25 15:37 ` Dmitry Gutov
2015-06-25 16:36 ` Paul Eggert
2015-06-25 17:00 ` Oleh Krehel
2015-06-25 20:48 ` Paul Eggert
2015-06-25 21:10 ` Dmitry Gutov
2015-06-25 22:15 ` Paul Eggert
2015-06-25 22:25 ` Dmitry Gutov
2015-06-25 22:41 ` Paul Eggert
2015-06-25 22:52 ` Dmitry Gutov
2015-06-27 15:00 ` raman
2015-06-25 18:32 ` Dmitry Gutov
2015-06-25 22:17 ` Paul Eggert
2015-06-25 22:38 ` Dmitry Gutov
2015-06-26 2:35 ` Paul Eggert
2015-06-26 12:06 ` Dmitry Gutov
2015-06-27 17:28 ` Paul Eggert
2015-06-27 17:53 ` Dmitry Gutov
2015-06-27 21:09 ` Paul Eggert
2015-06-28 1:04 ` Dmitry Gutov
2015-06-28 15:20 ` Paul Eggert
2015-06-28 20:27 ` Escaping quotes in docstrings, Was: " Dmitry Gutov
2015-06-28 23:29 ` Dmitry Gutov
2015-07-01 2:56 ` Paul Eggert
2015-07-02 0:09 ` Dmitry Gutov
2015-07-02 6:57 ` Paul Eggert
2015-07-02 9:46 ` Dmitry Gutov
2015-07-06 6:12 ` Paul Eggert
2015-07-06 12:07 ` Dmitry Gutov [this message]
2015-07-06 16:30 ` Paul Eggert
2015-07-06 22:10 ` Dmitry Gutov
2015-07-07 7:54 ` Paul Eggert
2015-07-07 8:39 ` Dmitry Gutov
2015-08-01 1:36 ` Paul Eggert
2015-08-01 21:05 ` Dmitry Gutov
2015-08-02 6:56 ` Paul Eggert
2015-08-02 12:51 ` Dmitry Gutov
2015-08-02 15:13 ` Paul Eggert
2015-08-02 18:31 ` Dmitry Gutov
2015-08-02 8:49 ` Przemysław Wojnowski
2015-08-02 19:16 ` Drew Adams
2015-06-27 17:57 ` Dmitry Gutov
2015-06-25 23:12 ` João Távora
2015-06-26 7:40 ` Oleh Krehel
2015-06-26 14:54 ` Paul Eggert
2015-06-26 15:03 ` Dmitry Gutov
2015-06-25 20:58 ` Alan Mackenzie
2015-06-25 22:34 ` Paul Eggert
2015-06-25 22:40 ` Dmitry Gutov
2015-06-25 22:45 ` Paul Eggert
2015-06-25 22:55 ` Dmitry Gutov
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=559A6F86.2080809@yandex.ru \
--to=dgutov@yandex.ru \
--cc=eggert@cs.ucla.edu \
--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).