emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
From: Kyle Meyer <kyle@kyleam.com>
To: Org-mode <emacs-orgmode@gnu.org>
Subject: [DEV] Text quoting backports
Date: Sun, 06 Sep 2015 02:12:40 -0400	[thread overview]
Message-ID: <87a8t0jctj.fsf@kyleam.com> (raw)

Hello,

There have been several commits made recently in the Emacs repo related
to quoting style in docstrings and messages.  I've backported the
changes touching Org files and pushed to the branch maint-quotes.  I put
them there instead of installing them directly on maint to allow time
for things in the Emacs repo to settle and to get feedback about how I
plan to incorporate these changes.  (Judging from the discussion on
emacs.devel [1-5], there may be various opinions on this.)

Regardless of how we decide to use these changes, I'd prefer to include
all the commits and then follow up with additional commits necessary to
get to the desired state.  This way there is a clear record of each
commit being considered.

Below is my plan at the moment, organized by different types of changes.
Thoughts?

------------------------------------------------------------------------

* s/'symbol/`symbol'/

  Keep changes.

* s/'.*'/‘.*’/ and s/`.*'/‘.*’/

  Revert changes. Regardless of whether these substitutions are made,
  these will be handled by message and friends to display according to
  text-quoting-style, so the displayed result in the help buffer will be
  the same.

* s/\".*\" /“.*”/

  Revert changes.

* s/'/\\='/

  Keep changes.

* s/'(.*)/(.*)/

  Some of the changes removed single quotes.  For example,

  -    '((\"c\" \"d\" ((in-mode . \"message-mode\"))))
  +   ((\"c\" \"d\" ((in-mode . \"message-mode\"))))

  Others protected the single quote. For example,

  -    '((\"p\" \"q\" ((in-file . \"\\\\.txt\\\\'\"))))
  +    \\='((\"p\" \"q\" ((in-file . \"\\\\.txt\\\\'\"))))

  I've been unable to figure out the logic here as to when a quote form
  like this was removed versus protected.  I plan to convert all cases
  that were removed to \\=' instead.

* s/format/format-message/ calls

  Keep changes.

* Added substitute-command-keys calls

  Keep changes, but extend to use command names instead of hard coding
  keys.

------------------------------------------------------------------------

[1] http://thread.gmane.org/gmane.emacs.devel/189240
[2] http://thread.gmane.org/gmane.emacs.devel/188822
[3] http://thread.gmane.org/gmane.emacs.devel/189331
[4] http://thread.gmane.org/gmane.emacs.devel/189621
[5] And maybe other threads I'm missing

--
Kyle

             reply	other threads:[~2015-09-06  6:12 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2015-09-06  6:12 Kyle Meyer [this message]
2015-09-06 13:24 ` [DEV] Text quoting backports Rasmus
2015-09-06 14:43   ` Kyle Meyer
2015-09-07 19:18 ` Nicolas Goaziou

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.orgmode.org/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=87a8t0jctj.fsf@kyleam.com \
    --to=kyle@kyleam.com \
    --cc=emacs-orgmode@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/org-mode.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).