diff options
author | Sebastian Berg <sebastian@sipsolutions.net> | 2019-08-05 15:13:16 -0500 |
---|---|---|
committer | Sebastian Berg <sebastian@sipsolutions.net> | 2019-08-12 20:27:51 -0500 |
commit | da8d9f147bd703d1ebce41f9762cd83cbb0fa2a0 (patch) | |
tree | 3f64e8cb56321cc4a68e0936614d05bc6d3a4b91 /changelog/README.rst | |
parent | 67ecbcf6136842d503ef0603d249bc7eb7987383 (diff) | |
download | numpy-da8d9f147bd703d1ebce41f9762cd83cbb0fa2a0.tar.gz |
DOC,MAINT: Move towncrier files and fixup categories
Name all categories as singular (or adjectives). Also move the fragments
into an ``upcoming_changes`` folder to be more discoverable.
Notes that we format some things as bullet points traditionally (right now
towncrier only truly supports bullet point format, but I have a PR to fix
that).
Diffstat (limited to 'changelog/README.rst')
-rw-r--r-- | changelog/README.rst | 50 |
1 files changed, 0 insertions, 50 deletions
diff --git a/changelog/README.rst b/changelog/README.rst deleted file mode 100644 index 03f020c1e..000000000 --- a/changelog/README.rst +++ /dev/null @@ -1,50 +0,0 @@ -: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. - |