From aaef1fb2e443fae96c11cd1ef20cc293fd33caff Mon Sep 17 00:00:00 2001 From: Joel Nothman Date: Tue, 23 Apr 2019 18:14:24 +1000 Subject: [PATCH 1/2] DOC Describe what's new categories --- doc/whats_new.rst | 12 ++++++++++++ doc/whats_new/v0.21.rst | 14 ++++++++------ 2 files changed, 20 insertions(+), 6 deletions(-) diff --git a/doc/whats_new.rst b/doc/whats_new.rst index 03cbcd3ed34bc..bd36cf1a80471 100644 --- a/doc/whats_new.rst +++ b/doc/whats_new.rst @@ -11,6 +11,18 @@ Release notes for current and recent releases are detailed on this page, with **Tip:** `Subscribe to scikit-learn releases `__ on libraries.io to be notified when new versions are released. +Legend +------ + +- |MajorFeature|: something big that you couldn't do before. +- |Feature|: something that you couldn't do before. +- |Efficiency|: an existing feature now may not require as much computation or + memory. +- |Enhancement|: miscellaneous minor improvement. +- |Fix|: something that didn't work as documentated before should now work. +- |API|: you will need to change your code to have the same effect in the + future; or a feature will be removed in the future. + .. include:: whats_new/v0.21.rst .. include:: whats_new/v0.20.rst diff --git a/doc/whats_new/v0.21.rst b/doc/whats_new/v0.21.rst index a86fd0dfb2ec2..9b29ea757e583 100644 --- a/doc/whats_new/v0.21.rst +++ b/doc/whats_new/v0.21.rst @@ -51,12 +51,14 @@ Changelog Support for Python 3.4 and below has been officially dropped. .. - See version doc/whats_new/v0.20.rst for structure. Entries should be - prefixed with one of the labels: |MajorFeature|, |Feature|, |Efficiency|, - |Enhancement|, |Fix| or |API|. They should be under a heading for the - relevant module (or *Multiple Modules* or *Miscellaneous*), and within each - section should be ordered according to the label ordering above. Entries - should end with: :issue:`123456` by :user:`Joe Bloggs `. + Entries should be grouped by module (in alphabetic order) and prefixed with + one of the labels: |MajorFeature|, |Feature|, |Efficiency|, |Enhancement|, + |Fix| or |API| (see whats_new.rst for descriptions). + Entries should be ordered by those labels (e.g. |Fix| after |Efficiency|). + Changes not specific to a module should be listed under *Multiple Modules* + or *Miscellaneous*. + Entries should end with: + :issue:`123456` by :user:`Joe Bloggs `. :mod:`sklearn.base` ................... From deda9a6735a728bc7833b1b0e058b80f72ba207d Mon Sep 17 00:00:00 2001 From: Joel Nothman Date: Tue, 23 Apr 2019 23:07:17 +1000 Subject: [PATCH 2/2] Mention PR number --- doc/whats_new/v0.21.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/doc/whats_new/v0.21.rst b/doc/whats_new/v0.21.rst index 9b29ea757e583..473aa8d576193 100644 --- a/doc/whats_new/v0.21.rst +++ b/doc/whats_new/v0.21.rst @@ -59,6 +59,7 @@ Support for Python 3.4 and below has been officially dropped. or *Miscellaneous*. Entries should end with: :issue:`123456` by :user:`Joe Bloggs `. + where 123456 is the *pull request* number, not the issue number. :mod:`sklearn.base` ...................