Skip to content

Commit 0f6879b

Browse files
authored
Small update to changelog/README.rst
1 parent 00d3001 commit 0f6879b

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

changelog/README.rst

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
1-
This directory contains "newsfragments" which are short that contain a small **ReST**-formatted
1+
This directory contains "newsfragments" which are short files that contain a small **ReST**-formatted
22
text that will be added to the next ``CHANGELOG``.
33

44
The ``CHANGELOG`` will be read by users, so this description should be aimed to pytest users
55
instead of describing internal changes which are only relevant to the developers.
66

7-
Make sure to use full sentences with correct case and punctuation, for example: *Fix issue with non-ascii contents in doctest text files.*
7+
Make sure to use full sentences with correct case and punctuation, for example::
8+
9+
Fix issue with non-ascii messages from the ``warnings`` module.
810

911
Each file should be named like ``<ISSUE>.<TYPE>.rst``, where
1012
``<ISSUE>`` is an issue number, and ``<TYPE>`` is one of:

0 commit comments

Comments
 (0)