Skip to content

Commit 8157a3e

Browse files
jnothmanqinhanmin2014
authored andcommitted
DOC Describe what's new categories (scikit-learn#13697)
1 parent 5d2e897 commit 8157a3e

File tree

2 files changed

+21
-6
lines changed

2 files changed

+21
-6
lines changed

doc/whats_new.rst

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,18 @@ Release notes for current and recent releases are detailed on this page, with
1111
**Tip:** `Subscribe to scikit-learn releases <https://libraries.io/pypi/scikit-learn>`__
1212
on libraries.io to be notified when new versions are released.
1313

14+
Legend
15+
------
16+
17+
- |MajorFeature|: something big that you couldn't do before.
18+
- |Feature|: something that you couldn't do before.
19+
- |Efficiency|: an existing feature now may not require as much computation or
20+
memory.
21+
- |Enhancement|: miscellaneous minor improvement.
22+
- |Fix|: something that didn't work as documentated before should now work.
23+
- |API|: you will need to change your code to have the same effect in the
24+
future; or a feature will be removed in the future.
25+
1426
.. include:: whats_new/v0.21.rst
1527
.. include:: whats_new/v0.20.rst
1628

doc/whats_new/v0.21.rst

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -51,12 +51,15 @@ Changelog
5151
Support for Python 3.4 and below has been officially dropped.
5252

5353
..
54-
See version doc/whats_new/v0.20.rst for structure. Entries should be
55-
prefixed with one of the labels: |MajorFeature|, |Feature|, |Efficiency|,
56-
|Enhancement|, |Fix| or |API|. They should be under a heading for the
57-
relevant module (or *Multiple Modules* or *Miscellaneous*), and within each
58-
section should be ordered according to the label ordering above. Entries
59-
should end with: :issue:`123456` by :user:`Joe Bloggs <joeongithub>`.
54+
Entries should be grouped by module (in alphabetic order) and prefixed with
55+
one of the labels: |MajorFeature|, |Feature|, |Efficiency|, |Enhancement|,
56+
|Fix| or |API| (see whats_new.rst for descriptions).
57+
Entries should be ordered by those labels (e.g. |Fix| after |Efficiency|).
58+
Changes not specific to a module should be listed under *Multiple Modules*
59+
or *Miscellaneous*.
60+
Entries should end with:
61+
:issue:`123456` by :user:`Joe Bloggs <joeongithub>`.
62+
where 123456 is the *pull request* number, not the issue number.
6063
6164
:mod:`sklearn.base`
6265
...................

0 commit comments

Comments
 (0)