Skip to content

Commit 83bd17d

Browse files
sirosenStanFromIrelandwillingc
committed
Refine quick-reference explanation of NEWS entries
Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com> Co-authored-by: Carol Willing <2680980+willingc@users.noreply.github.com>
1 parent a908456 commit 83bd17d

2 files changed

Lines changed: 14 additions & 11 deletions

File tree

getting-started/pull-request-lifecycle.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -240,13 +240,20 @@ in the "What's New in Python" entry.
240240
A change that needs an entry in "What's New in Python"
241241
is very likely not suitable for inclusion in a maintenance release.
242242

243+
.. _news-entry-howto:
244+
243245
How to add a NEWS entry
244246
-----------------------
245247

246248
``NEWS`` entries go into the ``Misc/NEWS.d`` directory as individual files. The
247249
``NEWS`` entry can be created by using `blurb-it <https://blurb-it.herokuapp.com/>`_,
248250
or the :pypi:`blurb` tool and its ``blurb add`` command.
249251

252+
.. tip::
253+
254+
You can read more about ``blurb`` in its
255+
`repository <https://github.com/python/blurb>`__.
256+
250257
If you are unable to use the tool, then you can create the ``NEWS`` entry file
251258
manually. The ``Misc/NEWS.d`` directory contains a sub-directory named
252259
``next``, which contains various sub-directories representing classifications

getting-started/quick-reference.rst

Lines changed: 7 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -114,19 +114,15 @@ Document your changes
114114
---------------------
115115

116116
Many changes deserve a NEWS entry which documents what changed.
117+
For more information on how and when to write news entries,
118+
see :ref:`"Updating NEWS and What's New in Python" <news-entry>`.
117119

118-
Add a News entry into the ``Misc/NEWS.d/`` directory as individual file.
119-
The news entry can be created by using
120-
`blurb-it <https://blurb-it.herokuapp.com/>`__,
121-
or the :pypi:`blurb` tool and its ``blurb add`` command.
122-
123-
.. tip::
124-
125-
You can read more about ``blurb`` in its
126-
`repository <https://github.com/python/blurb>`__.
120+
A news entry can be created locally with the :pypi:`blurb` tool
121+
and its ``blurb add`` command or online after a pull request has
122+
been opened with blurb-it <https://blurb-it.herokuapp.com/>__.
127123

128-
For more information on writing news entries,
129-
see :ref:`"Updating NEWS and What's New in Python" <news-entry>`.
124+
For more information about how to create news entries, see
125+
:ref:`"How to add a NEWS entry" <news-entry-howto>`.
130126

131127
Create pull requests
132128
--------------------

0 commit comments

Comments
 (0)