Apply suggestions from code review

Co-authored-by: stuartarchibald <[email protected]>
Deezy33-creator · Mar 30, 2023 · 494d89c · 494d89c
1 parent b491812
commit 494d89c
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 6 deletions.
diff --git a/docs/source/developer/contributing.rst b/docs/source/developer/contributing.rst
@@ -323,10 +323,10 @@ imported with an ``pt`` prefix. For example, ``typing.Dict`` is imported as ``fr
 Release Notes
 '''''''''''''
 
-Pull Requests that add significant user-facing modifications, they may need to be mentioned in the release notes.
-To add a the release notes, you need to create a short ``.rst`` file with a summary and place it in 
+Pull Requests that add significant user-facing modifications may need to be mentioned in the release notes.
+To add a release note, a short ``.rst`` file needs creating containing a summary of the change and it needs to be placed in 
 ``docs/upcoming_changes``. The file ``docs/upcoming_changes/README.rst`` details the format
-and filename conventions.
+and file naming conventions.
 
 Stability
 '''''''''

diff --git a/docs/upcoming_changes/README.rst b/docs/upcoming_changes/README.rst
@@ -13,15 +13,15 @@ your user-facing changes as they should appear in the relase notes.
 Each file should be named like ``<PULL REQUEST>.<TYPE>.rst``, where
 ``<PULL REQUEST>`` is a pull request number, and ``<TYPE>`` is one of:
 
-* ``highlight``: Adds a highlight bullet point to use as a possibly highlight
+* ``highlight``: Adds a highlighted bullet point to use as a possible highlight
   of the release.
 * ``np_support``: Addition of new NumPy functionality.
-* ``deprecation``: Changes existing code to emit a DeprecationWarning.
+* ``deprecation``: Changes to existing code that will now emit a DeprecationWarning/PendingDeprecationWarning.
 * ``future``: Changes existing code to emit a FutureWarning.
 * ``expired``: Removal of a deprecated part of the API.
 * ``compatibility``: A change which requires users to change code and is not
   backwards compatible. (Not to be used for removal of deprecated features.)
-* ``cuda``: Changes in the CUDA API.
+* ``cuda``: Changes in the CUDA target implementation.
 * ``new_feature``: New user facing features like ``kwargs``.
 * ``improvement``: General improvements and edge-case changes which are
   not new features or compatibility related.