unofficial mirror of emacs-devel@gnu.org 
 help / color / mirror / code / Atom feed
From: Paul Eggert <eggert@cs.ucla.edu>
To: "Garreau, Alexandre" <galex-713@galex-713.eu>, emacs-devel@gnu.org
Subject: Re: In docstrings: `sym' and ‘sym’ are equivalent to mismatched `sym’ and ‘sym' (and ‘'sym’, nor `undefined' cannot be used)
Date: Thu, 18 Oct 2018 08:01:04 -0700	[thread overview]
Message-ID: <362fce9b-4e02-fe82-a91c-c2213afa2223@cs.ucla.edu> (raw)
In-Reply-To: <87zhvbuz47.fsf@portable.galex-713.eu>

On 10/18/18 7:07 AM, Garreau, Alexandre wrote:
> I noticed it while trying this:
>
> #+BEGIN_SRC emacs-lisp
> (defcustom gnus-build-sparse-threads nil
>    "*If non-nil, fill in the gaps in threads.
> If “'some”, only fill in the gaps that are needed to tie loose threads
> together.  If ‘'more’, fill in all leaf nodes that Gnus can find.  If
> non-nil and non-‘some’, fill in all gaps that Gnus manages to guess."

As Clément wrote, you could use `\\='more' if you want the curled 
version to look like ‘'more’. However, the curled version shouldn't look 
like that. It should look like ‘more’ without the apostrophe. Doc 
strings should talk about the values in question, not about code that 
would yield those values.




  parent reply	other threads:[~2018-10-18 15:01 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-10-18 14:07 In docstrings: `sym' and ‘sym’ are equivalent to mismatched `sym’ and ‘sym' (and ‘'sym’, nor `undefined' cannot be used) Garreau, Alexandre
2018-10-18 14:35 ` Clément Pit-Claudel
2018-10-18 14:58   ` Garreau, Alexandre
2018-10-18 15:01 ` Paul Eggert [this message]
2018-10-18 16:34   ` Garreau, Alexandre

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=362fce9b-4e02-fe82-a91c-c2213afa2223@cs.ucla.edu \
    --to=eggert@cs.ucla.edu \
    --cc=emacs-devel@gnu.org \
    --cc=galex-713@galex-713.eu \
    /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).