From 494d89cd0799abc55ca64e949a46f0df2209f152 Mon Sep 17 00:00:00 2001 From: Kaustubh Date: Thu, 30 Mar 2023 18:22:40 +0530 Subject: [PATCH] Apply suggestions from code review Co-authored-by: stuartarchibald --- docs/source/developer/contributing.rst | 6 +++--- docs/upcoming_changes/README.rst | 6 +++--- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/source/developer/contributing.rst b/docs/source/developer/contributing.rst index 4b1402cc962..90f6e8506a5 100644 --- 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 index 41b0cb4343a..ed2673fe21f 100644 --- 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 ``..rst``, where ```` is a pull request number, and ```` 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.