Address most of Ezio's review remarks

python · erlend-aasland · Dec 7, 2023 · Dec 6, 2023 · Dec 6, 2023 · Dec 6, 2023
commit 4def01c53b0babc160c200bc8c3497dd95af0ad0
diff --git a/core-developers/committing.rst b/core-developers/committing.rst
@@ -80,8 +80,8 @@ to enter the public source tree. Ask yourself the following questions:
 Updating NEWS and What's New in Python
 --------------------------------------

-Changes that entail NEWS entries
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Changes that require NEWS entries
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

 Almost all changes made to the code base deserve an entry in ``Misc/NEWS.d``.
 There are two notable exceptions to this general principle, and they
@@ -101,12 +101,12 @@ or changes that have not yet been included in any formal release
 Other changes that generally do not require ``NEWS`` entries are documentation changes,
 test changes, and strictly internal changes with no user-visible effects.

-Changes that entail What's New in Python entries
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Changes that require "What's New in Python" entries
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

 If a change is particularly interesting for end users (e.g. new features,
 significant improvements, or backwards-incompatible changes), an entry in
-the ``What's New in Python`` document (in ``Doc/whatsnew/``) should be added
+the ``What's New in Python`` document (in :cpy-file:`Doc/whatsnew/`) should be added
 in addition to the ``NEWS`` entry.

 In most cases, it is sufficient to reuse the wording from the ``NEWS`` entry
@@ -153,7 +153,7 @@ and its intended audience is mainly users, not core devs and contributors.
 Take this into consideration when wording your ``NEWS`` entry.
 Describe the user-visible effects of your change succinctly and accurately;
 avoid long technical elaborations, digressions, and do not expect or require
-the reader to have read the actuall diff for the change.
+the reader to have read the actual diff for the change.

 The contents of a ``NEWS`` file should be valid reStructuredText. An 80 character
 column width should be used. There is no indentation or leading marker in the