Skip to content

Commit 2d158cb

Browse files
committed
Clarify no referencing ref numbers in change notes
1 parent 9aa21f5 commit 2d158cb

File tree

1 file changed

+8
-5
lines changed

1 file changed

+8
-5
lines changed

docs/changelog-fragments/README.rst

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -32,11 +32,14 @@ for the users to understand what it means.
3232
combined with others, it will be a part of the "news digest"
3333
telling the readers **what changed** in a specific version of
3434
the library *since the previous version*. You should also use
35-
RST syntax for highlighting code (inline or block), linking
36-
parts of the docs or external sites.
37-
At the end, sign your change note by adding ``-- by
38-
:user:`github-username``` (replace ``github-username`` with
39-
your own!).
35+
*reStructuredText* syntax for highlighting code (inline or block),
36+
linking parts of the docs or external sites.
37+
However, you do not need to reference the issue or PR numbers here
38+
as *towncrier* will automatically add a reference to all of the
39+
affected issues when rendering the news file.
40+
If you wish to sign your change, feel free to add ``-- by
41+
:user:`github-username``` at the end (replace ``github-username``
42+
with your own!).
4043

4144
Finally, name your file following the convention that Towncrier
4245
understands: it should start with the number of an issue or a

0 commit comments

Comments
 (0)