all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: Drew Adams <drew.adams@oracle.com>
To: "Mattias Engdegård" <mattiase@acm.org>, "Eli Zaretskii" <eliz@gnu.org>
Cc: monnier@iro.umontreal.ca, emacs-devel@gnu.org
Subject: RE: Backslash-escaped brackets in string literals
Date: Sat, 25 Jan 2020 09:16:13 -0800 (PST)	[thread overview]
Message-ID: <22215450-ffbb-4188-a3c1-3cf0e74a6acd@default> (raw)
In-Reply-To: <CCB4470C-C4E2-4E95-86AA-66556E826CD3@acm.org>

> I think the manual should be amended at this point, and that
> we needn't require new doc strings to escape brackets in the leftmost
  ^^^^^^^^^^^^^^^^^^
> column.  Would this patch be acceptable for emacs-27?

"We need not" doesn't mean that no users of Elisp
need to use such escaping.

This messaging/doc is for everyone, not just the
developers who provide the code that GNU Emacs
distributes as part of Emacs.  And no user has ever
been "required" to use such escaping.  Let's keep
the target audience in mind: general Elisp users.

I think it's misleading and narrow to say "there
is no longer any need" for such escaping.

There can be such a need, if you're writing code
intended for more than just Emacs 27 and later.
3rd-party code is sometimes intended for multiple
releases.

In fact, it's probable that only a tiny minority
of Emacs users use the latest release, and only
the latest release.

It would be better to point out clearly that:

1. It never _hurts_ to provide such escaping.
2. Such escaping is appropriate for backward
   compatibility.  It presents no advantage for
   Emacs 27+, but it's helpful for older releases.




      parent reply	other threads:[~2020-01-25 17:16 UTC|newest]

Thread overview: 12+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-01-24 15:12 Backslash-escaped brackets in string literals Mattias Engdegård
2020-01-24 15:39 ` Eli Zaretskii
2020-01-24 17:36 ` Stefan Monnier
2020-01-24 22:22   ` Mattias Engdegård
2020-01-25  7:44     ` Eli Zaretskii
2020-01-25 10:34       ` Mattias Engdegård
2020-01-25 13:33         ` Eli Zaretskii
2020-01-25 15:32           ` Mattias Engdegård
2020-01-25 17:15             ` Eli Zaretskii
2020-01-26 11:24               ` Mattias Engdegård
2020-01-26 16:00                 ` Eli Zaretskii
2020-01-25 17:16             ` Drew Adams [this message]

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=22215450-ffbb-4188-a3c1-3cf0e74a6acd@default \
    --to=drew.adams@oracle.com \
    --cc=eliz@gnu.org \
    --cc=emacs-devel@gnu.org \
    --cc=mattiase@acm.org \
    --cc=monnier@iro.umontreal.ca \
    /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.