Skip to content

Fix (and modify) the What's New template #386

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
StanFromIreland wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Fix (and modify) the What's New template #386

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 11 additions & 37 deletions run_release.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,42 +45,20 @@
DOWNLOADS_SERVER = "downloads.nyc1.psf.io"
DOCS_SERVER = "docs.nyc1.psf.io"

WHATS_NEW_TEMPLATE = """
****************************
WHATS_NEW_TEMPLATE = """\
*****************************
What's new in Python {version}
****************************
*****************************

:Editor: TBD

.. Rules for maintenance:

* Anyone can add text to this document. Do not spend very much time
on the wording of your changes, because your text will probably
get rewritten to some degree.

* The maintainer will go through Misc/NEWS periodically and add
changes; it's therefore more important to add your changes to
Misc/NEWS than to this file.

* This is not a complete list of every single change; completeness
is the purpose of Misc/NEWS. Some changes I consider too small
or esoteric to include. If such a change is added to the text,
I'll just remove it. (This is another reason you shouldn't spend
too much time on writing your addition.)

* If you want to draw your new text to the attention of the
maintainer, add 'XXX' to the beginning of the paragraph or
section.

* It's OK to just add a fragmentary note about a change. For
example: "XXX Describe the transmogrify() function added to the
socket module." The maintainer will research the change and
write the necessary text.

* You can comment out your additions if you like, but it's not
necessary (especially when a final release is some months away).
is the purpose of Misc/NEWS. The editor may remove changes they
consider too small or esoteric to include.

* Credit the author of a patch or bugfix. Just the name is
* Credit the author of a patch or bugfix. Just the name is
sufficient; the e-mail address isn't necessary.

* It's helpful to add the issue number as a comment:
Expand All @@ -89,9 +67,6 @@
module.
(Contributed by P.Y. Developer in :gh:`12345`.)

This saves the maintainer the effort of going through the VCS log
when researching a change.

This article explains the new features in Python {version}, compared to {prev_version}.

For full details, see the :ref:`changelog <changelog>`.
Expand All @@ -113,17 +88,14 @@
.. PEP-sized items next.



New features
============



Other language changes
======================



New modules
===========

Expand All @@ -140,6 +112,7 @@

.. Add improved modules above alphabetically, not here at the end.


Optimizations
=============

Expand All @@ -149,14 +122,14 @@
* TODO



Removed
=======

module_name
-----------

* TODO

.. Add removals above alphabetically, not here at the end.


Expand All @@ -166,7 +139,6 @@
* module_name:
TODO


.. Add deprecations above alphabetically, not here at the end.


Expand All @@ -189,21 +161,23 @@

* TODO


Porting to Python {version}
----------------------

* TODO


Deprecated C APIs
-----------------

* TODO

.. Add C API deprecations above alphabetically, not here at the end.


Removed C APIs
--------------

"""


Expand Down
Loading