From: Uwe Brauer <oub@mat.ucm.es>
To: Paul Eggert <eggert@cs.ucla.edu>
Cc: Uwe Brauer <oub@mat.ucm.es>, emacs-devel@gnu.org
Subject: Re: elementary: how to display a ' in a docstring
Date: Sat, 07 May 2016 20:45:05 +0000 [thread overview]
Message-ID: <87vb2pwqb2.fsf@mat.ucm.es> (raw)
In-Reply-To: 572E4EC1.1030108@cs.ucla.edu
>>> "Paul" == Paul Eggert <eggert@cs.ucla.edu> writes:
> Uwe Brauer wrote:
>> "Please set `vc-hg-symbolic-revision-styles' to '(\"{rev}\"))),
>> please note the `''."
> To get the effect you asked for, quote the apostrophes like this:
> "Please set `vc-hg-symbolic-revision-styles' to \\='(\"{rev}\"))),
> please note the `\\=''." See the text-quoting-style documentation
> in the Elisp manual.
thanks
> By the way, the effect you asked for is not the recommended style in Emacs
> documentation strings. When discussing a Lisp value, the usual style is to give
> the value instead of Lisp code that would evaluate to the value. The
> abovementioned doc string could be reworded to something like "Please set
> `vc-hg-symbolic-revision-styles' to the list (\"{rev}\")."
I am now confused. Are you saying that the setting
(setq vc-hg-symbolic-revision-styles '("{rev}"))
Is incorrect?
What would be then correct? I am not sure that I understand your
proposed wording.
(setq vc-hg-symbolic-revision-styles (list '("{rev}")))
Is not correct. So I am puzzled.
next prev parent reply other threads:[~2016-05-07 20:45 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-05-07 18:00 elementary: how to display a ' in a docstring Uwe Brauer
2016-05-07 20:23 ` Paul Eggert
2016-05-07 20:45 ` Uwe Brauer [this message]
2016-05-07 20:52 ` Paul Eggert
2016-05-07 21:08 ` Uwe Brauer
2016-05-07 21:32 ` 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
List information: https://www.gnu.org/software/emacs/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=87vb2pwqb2.fsf@mat.ucm.es \
--to=oub@mat.ucm.es \
--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 public inbox
https://git.savannah.gnu.org/cgit/emacs.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).