Skip to content

Commit d145ed5

Browse files
Apply suggestions from code review
Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
1 parent 6f6fbae commit d145ed5

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

getting-started/pull-request-lifecycle.rst

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -280,7 +280,7 @@ in the "What's New in Python" entry.
280280

281281
.. note::
282282

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

286286
How to add a NEWS entry
@@ -325,12 +325,14 @@ column width should be used. There is no indentation or leading marker in the
325325
file (for example, ``-``). There is also no need to start the entry with the issue
326326
number since it is part of the file name. You can use
327327
:ref:`inline markups <rest-inline-markup>` too. Here is an example of a ``NEWS``
328-
entry::
328+
entry:
329+
330+
.. code-block:: rst
329331
330332
Fix warning message when :func:`os.chdir` fails inside
331333
:func:`test.support.temp_cwd`. Contributed by Chris Jerdonek.
332334
333-
The inline Sphinx roles like ``:func:`` can be used help readers
335+
The inline Sphinx roles like :rst:role:`:func: <py:func>` can be used help readers
334336
find more information. You can build HTML and verify that the
335337
link target is appropriate by using :ref:`make html <building-using-make>`.
336338

0 commit comments

Comments
 (0)