Skip to content

Move NEWS entries to pull-request-lifecycle #1506

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.

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
wants to merge 9 commits into
base: main
Choose a base branch
from
Open
Changes from 1 commit
Commits
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
Prev Previous commit
Next Next commit
Apply suggestions from code review
Co-authored-by: Bénédikt Tran <[email protected]>
  • Loading branch information
StanFromIreland and picnixz authored Mar 13, 2025
commit d145ed5a37fcc0838536e37efd6c3fa9bb5b55c0
8 changes: 5 additions & 3 deletions getting-started/pull-request-lifecycle.rst
Original file line number Diff line number Diff line change
Expand Up @@ -280,7 +280,7 @@ in the "What's New in Python" entry.

.. note::

A change that needs an entry in "What's New in Python",
A change that needs an entry in "What's New in Python"
is very likely not suitable for inclusion in a maintenance release.

How to add a NEWS entry
Expand Down Expand Up @@ -325,12 +325,14 @@ column width should be used. There is no indentation or leading marker in the
file (for example, ``-``). There is also no need to start the entry with the issue
number since it is part of the file name. You can use
:ref:`inline markups <rest-inline-markup>` too. Here is an example of a ``NEWS``
entry::
entry:

.. code-block:: rst

Fix warning message when :func:`os.chdir` fails inside
:func:`test.support.temp_cwd`. Contributed by Chris Jerdonek.

The inline Sphinx roles like ``:func:`` can be used help readers
The inline Sphinx roles like :rst:role:`:func: <py:func>` can be used help readers
find more information. You can build HTML and verify that the
link target is appropriate by using :ref:`make html <building-using-make>`.

Expand Down
Loading