@@ -6,8 +6,7 @@ Changelog
66This directory contains "news fragments" which are short files that contain a
77small **ReST **-formatted text that will be added to the next what's new page.
88
9- Make sure to use full sentences with correct case and punctuation, and please
10- try to use Sphinx intersphinx using backticks.
9+ Make sure to use full sentences with correct case and punctuation.
1110
1211Each file should be named like ``<PULL REQUEST>.<TYPE>.rst ``, where
1312``<PULL REQUEST> `` is a pull request number, and ``<TYPE> `` is one of:
@@ -17,18 +16,19 @@ Each file should be named like ``<PULL REQUEST>.<TYPE>.rst``, where
1716* ``bugfix ``: Bug fix.
1817* ``other ``: Other changes and additions.
1918
19+ If the change concern a sub-package, the file should go in the sub-directory
20+ relative to this sub-package.
21+
2022It is possible to add two files with different categories (and text) if both
2123are relevant. For example a change may add a new feature but introduce an API
2224change.
2325
2426So for example: ``123.feature.rst `` would have the content::
2527
26- The ``my_new_feature`` option is now available for `my_favorite_function`.
28+ The ``my_new_feature`` option is now available for `` my_favorite_function` `.
2729 To use it, write ``np.my_favorite_function(..., my_new_feature=True)``.
2830
29- Note the use of single-backticks to get an internal link (assuming
30- ``my_favorite_function `` is exported from the ``numpy `` namespace),
31- and double-backticks for code.
31+ Note the use of double-backticks for code.
3232
3333If you are unsure what pull request type to use, don't hesitate to ask in your
3434PR.
0 commit comments