all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: Drew Adams <drew.adams@oracle.com>
To: Paul Eggert <eggert@cs.ucla.edu>
Cc: emacs-devel@gnu.org
Subject: RE: how to turn off automatic curly-quoting?
Date: Mon, 3 Aug 2015 12:33:01 -0700 (PDT)	[thread overview]
Message-ID: <41ca0ff6-3c02-4202-9dd4-bb3192a6c417@default> (raw)
In-Reply-To: <55BFBA12.4070505@cs.ucla.edu>

> > Do you know of other occurrences of quoting ordinary text with `...'
> > in Emacs?  I doubt it
> 
> It's done all the time.  Here are some examples:
> 
> "Add `See also ...' to WIDGET if there are any links...."
> "... The `ISO year' corresponds approximately to the Gregorian year, but
> weeks start on Monday and end on Sunday...."
> "If nil, Comint will interpret `carriage control' characters in
> output...."

1. All bugs, IMO, though I don't have the contexts.

Without context it's hard to know just what is the fix in each case.
If "ISO year" is meant to be a placeholder such as a parameter, for
example, then the Elisp manual would instead use ISO-YEAR (no quotes
and no spaces).

I don't see `ISO year' in either the Emacs manual or the Elisp manual.
And yes, it is more likely that doc/manual bugs are found in other
manuals, especially when written by 3rd parties.  Eli doesn't have the
same time to devote to all other manuals as he does to the two main
manuals, where he often identifies and fixes such bugs.  And there
are fewer user eyes on such manuals, so such problems get reported
less often.

2. If you are quoting ordinary text then use whatever Emacs uses to
quote ordinary text (not code, keys, URLs, and file names).

So what does Emacs use to quote ordinary text?

* It might be "..." (which it uses to introduce glossary terms), or it
  might not be.  The use of "..." for anything other than code strings
  is also a bad idea, IMO.  Unless we systematically put inline code
  strings within code quotes (e.g., ‘"a code string"’).

* It could be curly double-quotes, but it doesn't seem to be so far.

* It could be curly single-quotes, if Emacs adopted British style.  It
  could be the case for American style too, but only for an embedded
  quote (of which there are probably none in the existing doc).

Whatever it is, it might well apply to the examples you just gave.
At first sight, at least, those just quote ordinary text, AFAICT.

> Although I tend to agree with you that this is not good style, evidently
> not everyone shares our tastes.  In any event there's no harm translating
> these to curved quotes, as is done in current Emacs master.

There is definitely harm in doing so, since that's the convention you
are adopting for code etc.  That's the point.

Inline code etc. is not just ordinary text-quoting.  You've chosen an
inappropriate mechanism for setting off code etc., one that is easily
confusable with ordinary text quoting.  A no-no, by any ordinary doc
 standards.  But of course, Emacs can do whatever it likes - or apparently
whatever you like.



  reply	other threads:[~2015-08-03 19:33 UTC|newest]

Thread overview: 22+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
     [not found] <<36f6e67e-45d9-4eca-8302-ad9a06d138f1@default>
     [not found] ` <<83fv41v6fh.fsf@gnu.org>
2015-08-02 21:47   ` how to turn off automatic curly-quoting? Drew Adams
2015-08-02 23:06     ` Paul Eggert
2015-08-02 23:57       ` Artur Malabarba
2015-08-03  0:11         ` Paul Eggert
2015-08-03  0:02       ` Drew Adams
2015-08-03  0:40         ` Paul Eggert
2015-08-03  2:28           ` Drew Adams
2015-08-03  5:11             ` Paul Eggert
2015-08-03 15:13       ` Eli Zaretskii
2015-08-03 16:49         ` Paul Eggert
2015-08-03 17:31           ` Drew Adams
2015-08-03 18:59             ` Paul Eggert
2015-08-03 19:33               ` Drew Adams [this message]
2015-08-03 21:06                 ` Paul Eggert
2015-08-03 19:14           ` Eli Zaretskii
     [not found]   ` <<5681a732-5741-4f56-b3d7-cb1edb739d32@default>
     [not found]     ` <<55BEA291.70402@cs.ucla.edu>
     [not found]       ` <<83a8u8v1zk.fsf@gnu.org>
2015-08-03 15:48         ` Drew Adams
2015-08-03 16:14           ` Eli Zaretskii
2015-08-02 17:18 Drew Adams
2015-08-02 19:25 ` Eli Zaretskii
2015-08-02 19:46   ` Paul Eggert
2015-08-02 20:11     ` Drew Adams
2015-08-02 20:26       ` Paul Eggert

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=41ca0ff6-3c02-4202-9dd4-bb3192a6c417@default \
    --to=drew.adams@oracle.com \
    --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 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.