From: Eli Zaretskii <eliz@gnu.org>
To: Xue Fuqiao <xfq.free@gmail.com>
Cc: emacs-devel@gnu.org
Subject: Re: When should I use "`" and "'" in NEWS?
Date: Sat, 15 Jun 2013 10:08:06 +0300 [thread overview]
Message-ID: <83mwqrvokp.fsf@gnu.org> (raw)
In-Reply-To: <CAAF+z6E-3OgttqCWtGXfbL4QaPTObqVwxujz7nPBwFTGUjy3Mw@mail.gmail.com>
> Date: Sat, 15 Jun 2013 10:51:58 +0800
> From: Xue Fuqiao <xfq.free@gmail.com>
>
> In etc/NEWS[fn:1], I found this sentence:
>
> You should either convert them to utf-8 or add an explicit coding:
> cookie.
>
> I expected a "`" and a "'" around the "coding:" cookie, but there's
> none.
So add them.
> So I have a question: when should we add these delimiters?
When you think they are appropriate. There's no formal grammar for
NEWS, it's just more or less free text.
> IMHO at least these things need those delimiters:
> * Lisp symbols
> * Configure options
>
> and there are something I'm uncertain about:
> * Key sequences
> * Code span (I think "coding:" cookie is belong to this category)
> * "Modules" (like those in Eshell and Org)
> * Library/package names (with or without `.el')
> * Value of Lisp variables
> * Value returned by functions/lambda/primitives/macros
Think of NEWS as an Info file, and decorate everything makeinfo would.
prev parent reply other threads:[~2013-06-15 7:08 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2013-06-15 2:51 When should I use "`" and "'" in NEWS? Xue Fuqiao
2013-06-15 7:08 ` Eli Zaretskii [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=83mwqrvokp.fsf@gnu.org \
--to=eliz@gnu.org \
--cc=emacs-devel@gnu.org \
--cc=xfq.free@gmail.com \
/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.