From: Eli Zaretskii <eliz@gnu.org>
To: "Mattias Engdegård" <mattiase@acm.org>
Cc: emacs-devel@gnu.org
Subject: Re: Backslash-escaped brackets in string literals
Date: Fri, 24 Jan 2020 17:39:44 +0200 [thread overview]
Message-ID: <83r1zorhhb.fsf@gnu.org> (raw)
In-Reply-To: <E4DAA2B8-879A-4791-8DDF-608433A1C749@acm.org> (message from Mattias Engdegård on Fri, 24 Jan 2020 16:12:51 +0100)
> From: Mattias Engdegård <mattiase@acm.org>
> Date: Fri, 24 Jan 2020 16:12:51 +0100
>
> • If a line in a documentation string begins with an
> open-parenthesis, write a backslash before the open-parenthesis,
> like this:
>
> The argument FOO can be either a number
> \(a buffer position) or a string (a file name).
>
> This prevents the open-parenthesis from being treated as the start
> of a defun (*note Defuns: (emacs)Defuns.).
>
> First of all, is this still true?
Not really, but I'd hesitate to remove this, see below.
> I rarely bother escaping brackets in doc strings and it doesn't seem to cause any editing confusion.
Try "C-x 4 a" in a function with such a doc string, but without the
escape, and you will see confusion.
I don't think we should remove the escapes in column zero, at least
not yet. The changes which made them not 100% required are too young,
and I expect many people to edit new sources with old Emacsen (I do
that all the time).
Thanks.
next prev parent reply other threads:[~2020-01-24 15:39 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 [this message]
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
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=83r1zorhhb.fsf@gnu.org \
--to=eliz@gnu.org \
--cc=emacs-devel@gnu.org \
--cc=mattiase@acm.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.