Skip to content

Commit 0ffaaf8

Browse files
authored
Merge pull request #17749 from seberg/performance-section
DOC: Add "performance" category to the release notes
2 parents bd6b1ec + 399e916 commit 0ffaaf8

3 files changed

Lines changed: 12 additions & 1 deletion

File tree

File renamed without changes.

‎doc/release/upcoming_changes/README.rst‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,11 +21,17 @@ Each file should be named like ``<PULL REQUEST>.<TYPE>.rst``, where
2121
backwards compatible. (Not to be used for removal of deprecated features.)
2222
* ``c_api``: Changes in the Numpy C-API exported functions
2323
* ``new_feature``: New user facing features like ``kwargs``.
24-
* ``improvement``: Performance and edge-case changes
24+
* ``improvement``: General improvements and edge-case changes which are
25+
not new features or compatibility related.
26+
* ``performance``: Performance changes that should not affect other behaviour.
2527
* ``change``: Other changes
2628
* ``highlight``: Adds a highlight bullet point to use as a possibly highlight
2729
of the release.
2830

31+
It is possible to add two files with different categories (and text) if both
32+
are relevant. For example a change may improve performance but have some
33+
compatibility concerns.
34+
2935
Most categories should be formatted as paragraphs with a heading.
3036
So for example: ``123.new_feature.rst`` would have the content::
3137

‎pyproject.toml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,11 @@ requires = [
6464
name = "Improvements"
6565
showcontent = true
6666

67+
[[tool.towncrier.type]]
68+
directory = "performance"
69+
name = "Performance improvements and changes"
70+
showcontent = true
71+
6772
[[tool.towncrier.type]]
6873
directory = "change"
6974
name = "Changes"

0 commit comments

Comments
 (0)