diff --git a/changelog/README.rst b/changelog/README.rst index f00720de9..35d3a40ed 100644 --- a/changelog/README.rst +++ b/changelog/README.rst @@ -1,10 +1,12 @@ -This directory contains "newsfragments" which are short that contain a small **ReST**-formatted +This directory contains "newsfragments" which are short files that contain a small **ReST**-formatted text that will be added to the next ``CHANGELOG``. The ``CHANGELOG`` will be read by users, so this description should be aimed to pytest users instead of describing internal changes which are only relevant to the developers. -Make sure to use full sentences with correct case and punctuation, for example: *Fix issue with non-ascii contents in doctest text files.* +Make sure to use full sentences with correct case and punctuation, for example:: + + Fix issue with non-ascii messages from the ``warnings`` module. Each file should be named like ``..rst``, where ```` is an issue number, and ```` is one of: