orphan:

Changelog

This directory contains "news fragments" which are short files that contain a small ReST-formatted text that will be added to the next what's new page.

Make sure to use full sentences with correct case and punctuation, and please try to use Sphinx intersphinx using backticks. The fragment should have a header line and an underline using ------

Each file should be named like <PULL REQUEST>.<TYPE>.rst, where <PULL REQUEST> is a pull request number, and <TYPE> is one of:

• new_function: New user facing functions.
• deprecation: Changes existing code to emit a DeprecationWarning.
• future: Changes existing code to emit a FutureWarning.
• expired: Removal of a deprecated part of the API.
• compatibility: A change which requires users to change code and is not backwards compatible. (Not to be used for removal of deprecated features.)
• c_api: Changes in the Numpy C-API exported functions
• new_features: New user facing features like kwargs.
• improvements: Performance and edge-case changes
• changes: Other changes

So for example: 123.new_features.rst would have the content:

my_new_feature option for `my_favorite_function`
------------------------------------------------
The ``my_new_feature`` option is now available for `my_favorite_function`.
To use it, write ``np.my_favorite_function(..., my_new_feature=True)``.

Note the use of single-backticks to get an internal link (assuming my_favorite_function is exported from the numpy namespace), and double- backticks for code.

If you are unsure what pull request type to use, don't hesitate to ask in your PR.

You can install towncrier and run towncrier --draft --version NumPy if you want to get a preview of how your change will look in the final release notes.

Note

This README was adapted from the pytest changelog readme under the terms of the MIT licence.