Skip to content

Commit 5f92ae8

Browse files
Fix (and modify) the What's New template (#386)
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
1 parent e6a9269 commit 5f92ae8

1 file changed

Lines changed: 10 additions & 36 deletions

File tree

run_release.py

Lines changed: 10 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -46,41 +46,19 @@
4646
DOCS_SERVER = "docs.nyc1.psf.io"
4747

4848
WHATS_NEW_TEMPLATE = """
49-
****************************
49+
*****************************
5050
What's new in Python {version}
51-
****************************
51+
*****************************
5252
5353
:Editor: TBD
5454
5555
.. Rules for maintenance:
5656
57-
* Anyone can add text to this document. Do not spend very much time
58-
on the wording of your changes, because your text will probably
59-
get rewritten to some degree.
60-
61-
* The maintainer will go through Misc/NEWS periodically and add
62-
changes; it's therefore more important to add your changes to
63-
Misc/NEWS than to this file.
64-
6557
* This is not a complete list of every single change; completeness
66-
is the purpose of Misc/NEWS. Some changes I consider too small
67-
or esoteric to include. If such a change is added to the text,
68-
I'll just remove it. (This is another reason you shouldn't spend
69-
too much time on writing your addition.)
70-
71-
* If you want to draw your new text to the attention of the
72-
maintainer, add 'XXX' to the beginning of the paragraph or
73-
section.
74-
75-
* It's OK to just add a fragmentary note about a change. For
76-
example: "XXX Describe the transmogrify() function added to the
77-
socket module." The maintainer will research the change and
78-
write the necessary text.
79-
80-
* You can comment out your additions if you like, but it's not
81-
necessary (especially when a final release is some months away).
58+
is the purpose of Misc/NEWS. The editor may remove changes they
59+
consider too small or esoteric to include.
8260
83-
* Credit the author of a patch or bugfix. Just the name is
61+
* Credit the author of a patch or bugfix. Just the name is
8462
sufficient; the e-mail address isn't necessary.
8563
8664
* It's helpful to add the issue number as a comment:
@@ -89,9 +67,6 @@
8967
module.
9068
(Contributed by P.Y. Developer in :gh:`12345`.)
9169
92-
This saves the maintainer the effort of going through the VCS log
93-
when researching a change.
94-
9570
This article explains the new features in Python {version}, compared to {prev_version}.
9671
9772
For full details, see the :ref:`changelog <changelog>`.
@@ -113,17 +88,14 @@
11388
.. PEP-sized items next.
11489
11590
116-
11791
New features
11892
============
11993
12094
121-
12295
Other language changes
12396
======================
12497
12598
126-
12799
New modules
128100
===========
129101
@@ -140,6 +112,7 @@
140112
141113
.. Add improved modules above alphabetically, not here at the end.
142114
115+
143116
Optimizations
144117
=============
145118
@@ -149,14 +122,14 @@
149122
* TODO
150123
151124
152-
153125
Removed
154126
=======
155127
156128
module_name
157129
-----------
158130
159131
* TODO
132+
160133
.. Add removals above alphabetically, not here at the end.
161134
162135
@@ -166,7 +139,6 @@
166139
* module_name:
167140
TODO
168141
169-
170142
.. Add deprecations above alphabetically, not here at the end.
171143
172144
@@ -189,21 +161,23 @@
189161
190162
* TODO
191163
164+
192165
Porting to Python {version}
193166
----------------------
194167
195168
* TODO
196169
170+
197171
Deprecated C APIs
198172
-----------------
199173
200174
* TODO
201175
202176
.. Add C API deprecations above alphabetically, not here at the end.
203177
178+
204179
Removed C APIs
205180
--------------
206-
207181
"""
208182

209183

0 commit comments

Comments
 (0)