diff options
| author | Sebastian Berg <sebastian@sipsolutions.net> | 2020-11-10 10:58:14 -0600 |
|---|---|---|
| committer | Sebastian Berg <sebastian@sipsolutions.net> | 2020-11-10 11:26:08 -0600 |
| commit | 399e91659a13a0f53ccc62875da65208b0b8514d (patch) | |
| tree | af9df4e36f1b622b6a67bf3122146965ef9c9f34 /doc/release | |
| parent | 17cd07f11fdbc6826c2ac5ae566012473ae94278 (diff) | |
| download | numpy-399e91659a13a0f53ccc62875da65208b0b8514d.tar.gz | |
DOC: Add "performance" category to the release notes
Diffstat (limited to 'doc/release')
| -rw-r--r-- | doc/release/upcoming_changes/13516.performance.rst (renamed from doc/release/upcoming_changes/13516.improvement.rst) | 0 | ||||
| -rw-r--r-- | doc/release/upcoming_changes/README.rst | 8 |
2 files changed, 7 insertions, 1 deletions
diff --git a/doc/release/upcoming_changes/13516.improvement.rst b/doc/release/upcoming_changes/13516.performance.rst index 1b32b61d7..1b32b61d7 100644 --- a/doc/release/upcoming_changes/13516.improvement.rst +++ b/doc/release/upcoming_changes/13516.performance.rst diff --git a/doc/release/upcoming_changes/README.rst b/doc/release/upcoming_changes/README.rst index 7f6476bda..ff5ca514c 100644 --- a/doc/release/upcoming_changes/README.rst +++ b/doc/release/upcoming_changes/README.rst @@ -21,11 +21,17 @@ Each file should be named like ``<PULL REQUEST>.<TYPE>.rst``, where backwards compatible. (Not to be used for removal of deprecated features.) * ``c_api``: Changes in the Numpy C-API exported functions * ``new_feature``: New user facing features like ``kwargs``. -* ``improvement``: Performance and edge-case changes +* ``improvement``: General improvements and edge-case changes which are + not new features or compatibility related. +* ``performance``: Performance changes that should not affect other behaviour. * ``change``: Other changes * ``highlight``: Adds a highlight bullet point to use as a possibly highlight of the release. +It is possible to add two files with different categories (and text) if both +are relevant. For example a change may improve performance but have some +compatibility concerns. + Most categories should be formatted as paragraphs with a heading. So for example: ``123.new_feature.rst`` would have the content:: |