unofficial mirror of emacs-devel@gnu.org 
 help / color / mirror / code / Atom feed
From: Drew Adams <drew.adams@oracle.com>
To: bruce.connor.am@gmail.com, emacs-devel <emacs-devel@gnu.org>
Subject: RE: How to properly document that a feature is new
Date: Mon, 11 May 2015 11:12:29 -0700 (PDT)	[thread overview]
Message-ID: <9bb242ca-8559-40da-868c-5ea4c78948c8@default> (raw)
In-Reply-To: <CAAdUY-L_AO1fokAX8tO9E8QhnGTNNJrJ-QxLNqe8TaPwCvFDUg@mail.gmail.com>

> My question is: where do I specifically document the fact that this
> is new to 25.1?  Docstring, manual, both, or neither?

NEWS (only).  (Well, AntiNEWS too, if that still exists.)

NEWS is the Emacs equivalent of Release Notes.  In general, only NEWS
covers release-specific stuff.

The current doc should describe the current release of Emacs.  It can
mention that XYZ started with version N.M of Emacs, if that is really
needed for some reason (e.g. security), but that should be the case
rarely, if at all.

(My opinion, not necessarily official policy.)



  reply	other threads:[~2015-05-11 18:12 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2015-05-11 18:00 How to properly document that a feature is new Artur Malabarba
2015-05-11 18:12 ` Drew Adams [this message]
2015-05-11 18:21   ` Eli Zaretskii
2015-05-11 20:25   ` Stefan Monnier

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=9bb242ca-8559-40da-868c-5ea4c78948c8@default \
    --to=drew.adams@oracle.com \
    --cc=bruce.connor.am@gmail.com \
    --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).