File tree 1 file changed +8
-5
lines changed 1 file changed +8
-5
lines changed Original file line number Diff line number Diff line change @@ -32,11 +32,14 @@ for the users to understand what it means.
32
32
combined with others, it will be a part of the "news digest"
33
33
telling the readers **what changed ** in a specific version of
34
34
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!).
40
43
41
44
Finally, name your file following the convention that Towncrier
42
45
understands: it should start with the number of an issue or a
You can’t perform that action at this time.
0 commit comments