From: Michael Albinus <michael.albinus@gmx.de>
To: 66067@debbugs.gnu.org
Cc: eliz@gnu.org, yantar92@posteo.net
Subject: bug#66067: 30.0.50; CONTRIBUTE: Questions about instructions on etc/NEWS file markup
Date: Mon, 18 Sep 2023 17:13:43 +0200 [thread overview]
Message-ID: <87il87a508.fsf@gmx.de> (raw)
In-Reply-To: <834jjrg20d.fsf@gnu.org> (Eli Zaretskii's message of "Mon, 18 Sep 2023 14:21:54 +0300")
Eli Zaretskii <eliz@gnu.org> writes:
Hi,
>> 3. "Documenting your changes" section of CONTRIBUTE file refers to
>> documentation tips section of Elisp manual. However, NEWS file
>> appears to use a slightly different quoting scheme for variable and
>> function names. For example,
>>
>> ** 'write-region-inhibit-fsync' now defaults to t in interactive mode,
>>
>> uses straight quotes '...', not the usual `...' docstring style.
>
> We support both styles, and there are strong feelings in both camps.
> 'Nough said.
Quoting 'this style' results in clickable symbol buttons, when viewed with
`emacs-news-view-mode'. See regexp "'\\([^-][^ \t\n]+\\)'".
>> 4. I was also confused how to refer to info nodes from NEWS. I found one
>> example in
>>
>> For more information, see the "(eshell) Built-ins" node in the Eshell
>> manual.
>>
>> but the convention is not documented anywhere.
>
> There is no such convention. The r_is_ a convention for this in Lisp
> doc strings, and it is described in the ELisp manual.
In the NEWS file, we prefer such a convention. In
`emacs-news-view-mode', all text matching "\"\\(([a-z0-9-]+)[
\n][^\"]\\{1,80\\}\\)\"" is regarded as info manual reference, and it is
buttonized accordingly.
Both conventions are implemented in `emacs-news--buttonize'. Other NEWS
files, like ERC-NEWS, follow these conventions.
Best regards, Michael.
next prev parent reply other threads:[~2023-09-18 15:13 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-09-18 8:38 bug#66067: 30.0.50; CONTRIBUTE: Questions about instructions on etc/NEWS file markup Ihor Radchenko
2023-09-18 11:21 ` Eli Zaretskii
2023-09-18 15:13 ` Michael Albinus [this message]
2023-09-19 10:12 ` Ihor Radchenko
2023-09-19 10:58 ` Ihor Radchenko
2023-09-19 12:11 ` Eli Zaretskii
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=87il87a508.fsf@gmx.de \
--to=michael.albinus@gmx.de \
--cc=66067@debbugs.gnu.org \
--cc=eliz@gnu.org \
--cc=yantar92@posteo.net \
/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).