From: Paul Eggert <eggert@cs.ucla.edu>
To: Uwe Brauer <oub@mat.ucm.es>
Cc: emacs-devel@gnu.org
Subject: Re: elementary: how to display a ' in a docstring
Date: Sat, 7 May 2016 14:32:37 -0700 [thread overview]
Message-ID: <572E5EF5.5030801@cs.ucla.edu> (raw)
In-Reply-To: <87inypwp88.fsf@mat.ucm.es>
Uwe Brauer wrote:
> Ok but you complained, or seemed to complained that it is not good
> style. So what is the recommended setting in the case I mentioned?
If the suggested value is the singleton list ("{rev}"), then (setq
vc-hg-symbolic-revision-styles '("{rev}")) is a Lisp expression that sets the
variable to the suggested value. As that is the expression you already
mentioned, your code should be OK already.
My quibble was with the doc string you suggested. In a doc string generally the
simplest way to discuss a cons value like ("{rev}") is to write the value
without quoting it. In the rare cases where this is unclear, you can quote the
value the same way you would quote a symbol or any other piece of Lisp code in a
doc string, namely by surrounding it with ` and '.
prev parent reply other threads:[~2016-05-07 21:32 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
2016-05-07 20:52 ` Paul Eggert
2016-05-07 21:08 ` Uwe Brauer
2016-05-07 21:32 ` Paul Eggert [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
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=572E5EF5.5030801@cs.ucla.edu \
--to=eggert@cs.ucla.edu \
--cc=emacs-devel@gnu.org \
--cc=oub@mat.ucm.es \
/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).