Skip to content

Commit 29e6dc0

Browse files
authored
DOC: Add more instructions for updating the whatsnew (#42427)
1 parent afeb35e commit 29e6dc0

File tree

1 file changed

+15
-1
lines changed

1 file changed

+15
-1
lines changed

doc/source/development/contributing_codebase.rst

+15-1
Original file line numberDiff line numberDiff line change
@@ -812,7 +812,21 @@ Changes should be reflected in the release notes located in ``doc/source/whatsne
812812
This file contains an ongoing change log for each release. Add an entry to this file to
813813
document your fix, enhancement or (unavoidable) breaking change. Make sure to include the
814814
GitHub issue number when adding your entry (using ``:issue:`1234``` where ``1234`` is the
815-
issue/pull request number).
815+
issue/pull request number). Your entry should be written using full sentences and proper
816+
grammar.
817+
818+
When mentioning parts of the API, use a Sphinx ``:func:``, ``:meth:``, or ``:class:``
819+
directive as appropriate. Not all public API functions and methods have a
820+
documentation page; ideally links would only be added if they resolve. You can
821+
usually find similar examples by checking the release notes for one of the previous
822+
versions.
823+
824+
If your code is a bugfix, add your entry to the relevant bugfix section. Avoid
825+
adding to the ``Other`` section; only in rare cases should entries go there.
826+
Being as concise as possible, the description of the bug should include how the
827+
user may encounter it and an indication of the bug itself, e.g.
828+
"produces incorrect results" or "incorrectly raises". It may be necessary to also
829+
indicate the new behavior.
816830

817831
If your code is an enhancement, it is most likely necessary to add usage
818832
examples to the existing documentation. This can be done following the section

0 commit comments

Comments
 (0)