From: Drew Adams <drew.adams@oracle.com>
To: Nicolas Petton <nicolas@petton.fr>
Cc: eggert@cs.ucla.edu, 20385@debbugs.gnu.org,
Dmitry Gutov <dgutov@yandex.ru>
Subject: bug#20385: [PROPOSED PATCH] Support quoting 'like this' in doc strings
Date: Wed, 22 Apr 2015 07:52:56 -0700 (PDT) [thread overview]
Message-ID: <6837d058-ba18-461b-8af6-2c4e6d767348@default> (raw)
In-Reply-To: <87a8y0jmba.fsf@petton.fr>
> > I will add that one increasingly important use of `...' is that
> > doc gets copied and pasted to other, non-Emacs environments.
> >
> > You might think that `...' is "ugly" (and that is the ONLY
> > reason that's been given so far for changing it), but it has
> > the distinct advantage that it is a unique way of quoting
> > that separates itself from both strings ("...") and ordinary
> > text quoting (curly quotes, double and single).
> >
> > If you post doc pieces into a context such as Stack Exchange,
> > for example, you need only change the ' in `...' to `, to
> > have that new context also, like Emacs, treat the quoted
> > sexp specially - not a ordinary quoted text. That is, SE
> > uses `...` instead of `...', but it does the same thing
> > Emacs does, to make the result stand out as code and not as
> > just any old quoted text.
> >
> > If you change `...' to ordinary curly quoting, you lose
> > distinguishing what it quotes as code.
> >
> > Just one more consideration, another reason why the proposed
> > change is a bad idea, IMHO.
>
> I agree with you.
>
> Maybe a compromise could be to add as an alternative syntax `...`
> (just like SE or Markdown)? It would then fix the unbalanced quotes issue.
1. `...` is not as simple to parse (e.g. using regexps) for Emacs
highlighting etc.
2. But I also realize that I might not have been as clear in that post
as I should have been. It's not only about the (increasing) need
to be able to copy doc and paste it to other, non-Emacs environments.
The more important point is that Emacs uses `...' as a different
kind of quoting from ordinary text quoting. It is Emacs's way of
quoting code that is inline (i.e., within ordinary text).
In other doc systems one might use wrap such inline code with, say,
and XML element: <CodeInLine>(forward-char 3)</CodeInLine>. For
technical doc related to programming, there is typically *some* way
to set off inline code bits, to indicate that they are code, whether
they are keywords or pieces of programs. Emacs's way has been `...'.
And IMHO, it is a very good way. Very simple, and amenable to very
simple regexp identification and thus highlighting & retrieval.
If Emacs at some point decides to switch to another code-quoting
mechanism, that's one thing. But what it definitely should NOT do,
IMO, is to lose code quoting - lose talking about code from a meta
level, and just quote code bits normally, so they become confused
with ordinary text quoting.
That was really the point I was trying to make in my last point.
`...' is for code. Changing that to '...' loses the ability to
distinguish code from anything else being quoted normally.
next prev parent reply other threads:[~2015-04-22 14:52 UTC|newest]
Thread overview: 102+ messages / expand[flat|nested] mbox.gz Atom feed top
2015-04-20 18:39 bug#20385: [PROPOSED PATCH] Support quoting 'like this' in doc strings Paul Eggert
2015-04-20 19:37 ` Stefan Monnier
2015-04-21 0:18 ` Paul Eggert
2015-04-21 0:53 ` Drew Adams
2015-04-21 1:14 ` Stefan Monnier
2015-04-21 1:30 ` Drew Adams
2015-04-21 1:58 ` Stefan Monnier
2015-04-21 3:45 ` Paul Eggert
2015-04-21 14:52 ` Eli Zaretskii
2015-04-21 18:04 ` Stefan Monnier
2015-04-21 18:25 ` Eli Zaretskii
2015-04-21 19:34 ` Stefan Monnier
2015-04-21 19:50 ` Eli Zaretskii
2015-04-21 20:01 ` Dmitry Gutov
2015-04-22 7:00 ` Eli Zaretskii
2015-04-22 13:52 ` Drew Adams
2015-04-22 13:59 ` Nicolas Petton
2015-04-22 14:52 ` Drew Adams [this message]
2015-04-22 23:36 ` Paul Eggert
2015-04-23 0:23 ` Nicolas Petton
2015-04-23 6:45 ` Paul Eggert
2015-04-23 9:14 ` Nicolas Petton
2015-04-23 10:22 ` Paul Eggert
2015-04-23 11:15 ` Nicolas Petton
2015-04-23 17:32 ` Paul Eggert
2015-04-23 18:23 ` Drew Adams
2015-04-23 19:38 ` Paul Eggert
2015-04-23 20:07 ` Drew Adams
2015-04-23 20:12 ` Eli Zaretskii
2015-04-23 23:24 ` Paul Eggert
2015-04-24 0:24 ` Drew Adams
2015-04-24 4:47 ` Paul Eggert
2015-04-23 19:47 ` Nicolas Petton
2015-04-23 19:57 ` Dmitry Gutov
2015-04-23 2:19 ` Drew Adams
2015-04-23 6:45 ` Paul Eggert
2015-04-23 14:51 ` Drew Adams
2015-04-23 15:32 ` Drew Adams
2015-04-23 17:11 ` Paul Eggert
2015-04-23 19:55 ` Dmitry Gutov
2015-04-23 20:03 ` Eli Zaretskii
2015-04-23 20:13 ` Drew Adams
2015-04-24 6:11 ` Eli Zaretskii
2015-04-24 3:04 ` Dmitry Gutov
2015-04-24 6:46 ` Eli Zaretskii
2015-04-24 13:43 ` Artur Malabarba
2015-04-21 18:44 ` Nicolas Petton
2015-04-21 20:30 ` Stefan Monnier
2015-04-22 0:49 ` Paul Eggert
2015-04-22 23:37 ` Paul Eggert
2015-04-23 6:30 ` Eli Zaretskii
2015-04-21 18:35 ` Ivan Shmakov
2015-04-21 18:42 ` Eli Zaretskii
2015-04-21 19:37 ` Ivan Shmakov
2015-04-21 19:52 ` Eli Zaretskii
[not found] ` <mailman.1406.1429745828.904.bug-gnu-emacs@gnu.org>
2015-04-23 12:11 ` Alan Mackenzie
2015-04-23 12:35 ` Eli Zaretskii
2015-04-23 12:45 ` Alan Mackenzie
2015-04-23 13:06 ` Eli Zaretskii
[not found] ` <mailman.1407.1429745888.904.bug-gnu-emacs@gnu.org>
2015-04-23 12:27 ` Alan Mackenzie
2015-04-23 19:42 ` Paul Eggert
2015-05-13 7:30 ` bug#20385: [PATCH] Support curved quotes " Paul Eggert
2015-05-13 12:16 ` Dmitry Gutov
2015-05-13 15:13 ` Paul Eggert
2015-05-13 22:33 ` Dmitry Gutov
2015-05-14 3:24 ` Paul Eggert
2015-05-14 10:49 ` Dmitry Gutov
2015-05-15 7:49 ` Paul Eggert
2015-05-15 17:24 ` Dmitry Gutov
2015-05-15 18:54 ` Paul Eggert
2015-05-15 19:09 ` Dmitry Gutov
2015-05-15 21:13 ` Paul Eggert
2015-05-15 21:48 ` Dmitry Gutov
2015-05-15 23:52 ` Paul Eggert
2015-05-16 0:08 ` Dmitry Gutov
2015-05-16 0:11 ` Dmitry Gutov
2015-05-16 1:48 ` Paul Eggert
2015-05-16 8:27 ` Dmitry Gutov
2015-05-19 23:27 ` Paul Eggert
2015-05-20 2:22 ` Dmitry Gutov
2015-05-21 7:21 ` Paul Eggert
2015-05-21 10:01 ` Dmitry Gutov
2015-05-21 14:58 ` Paul Eggert
2015-05-22 3:41 ` Dmitry Gutov
2015-05-16 9:51 ` Andreas Schwab
2015-05-16 1:23 ` Drew Adams
2015-05-16 6:20 ` Paul Eggert
2015-05-16 7:36 ` Eli Zaretskii
2015-05-14 7:10 ` bug#20385: missing charset for non-ASCII text/x-patch MIME parts in Thunderbird Ivan Shmakov
2015-05-14 7:10 ` Ivan Shmakov
2015-05-14 8:28 ` Stephen J. Turnbull
2015-05-14 8:28 ` bug#20385: " Stephen J. Turnbull
2015-05-14 7:20 ` bug#20385: Support curved quotes in doc strings Ivan Shmakov
2015-05-14 14:55 ` Eli Zaretskii
2015-05-14 20:05 ` Ivan Shmakov
2015-05-14 20:12 ` Eli Zaretskii
2015-05-14 20:30 ` Ivan Shmakov
[not found] <<1429555155-4695-1-git-send-email-eggert@cs.ucla.edu>
2015-04-20 20:16 ` bug#20385: [PROPOSED PATCH] Support quoting 'like this' " Drew Adams
[not found] ` <<jwvtwwabnhp.fsf-monnier+emacsbugs@gnu.org>
[not found] ` <<5535974D.9050207@cs.ucla.edu>
[not found] ` <<jwvvbgqs2ud.fsf-monnier+emacsbugs@gnu.org>
[not found] ` <<5535C7F3.7020107@cs.ucla.edu>
[not found] ` <<83618p5y9w.fsf@gnu.org>
[not found] ` <<jwvk2x59x4g.fsf-monnier+emacsbugs@gnu.org>
[not found] ` <<83vbgp49ve.fsf@gnu.org>
[not found] ` <<jwv8udl9syp.fsf-monnier+emacsbugs@gnu.org>
[not found] ` <<83pp6x45x5.fsf@gnu.org>
[not found] ` <<5536ACB3.9040707@yandex.ru>
[not found] ` <<83lhhk4phe.fsf@gnu.org>
[not found] ` <<fe3d90cd-056a-49a6-a049-6df07e710663@default>
[not found] ` <<87a8y0jmba.fsf@petton.fr>
[not found] ` <<6837d058-ba18-461b-8af6-2c4e6d767348@default>
[not found] ` <<55383081.4010106@cs.ucla.edu>
[not found] ` <<87a8xzae0o.fsf@petton.fr>
[not found] ` <<55389500.8000404@cs.ucla.edu>
[not found] ` <<878udj9pfq.fsf@petton.fr>
[not found] ` <<5538C7EC.9010105@cs.ucla.edu>
[not found] ` <<877ft39juq.fsf@petton.fr>
[not found] ` <<55392C91.1010300@cs.ucla.edu>
[not found] ` <<84f4aea9-c3ef-44c5-ac06-0df72d223e8c@default>
[not found] ` <<55394A2E.8020002@cs.ucla.edu>
[not found] ` <<f978526c-c5e3-405d-ae75-63b9ed5d4537@default>
[not found] ` <<83lhhizjqw.fsf@gnu.org>
2015-04-23 20:15 ` Drew Adams
2015-04-24 6:12 ` Eli Zaretskii
[not found] ` <<55394E30.8040307@yandex.ru>
[not found] ` <<83oamezk77.fsf@gnu.org>
[not found] ` <<4b159230-cd7e-4cb9-a778-3ad7ed2ae301@default>
[not found] ` <<83k2x2ys1b.fsf@gnu.org>
2015-04-24 14:11 ` Drew Adams
2015-04-24 14:40 ` Eli Zaretskii
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=6837d058-ba18-461b-8af6-2c4e6d767348@default \
--to=drew.adams@oracle.com \
--cc=20385@debbugs.gnu.org \
--cc=dgutov@yandex.ru \
--cc=eggert@cs.ucla.edu \
--cc=nicolas@petton.fr \
/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.