From: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Date: Sun, 6 Oct 2024 22:42:11 +0000 (+0100)
Subject: [3.12] Doc: Simplify the definition of 'soft deprecated' (GH-124988) (#125030)
X-Git-Tag: v3.12.8~255
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=73d7393780b6d92909782148f50ec03f0db5892d;p=thirdparty%2FPython%2Fcpython.git

[3.12] Doc: Simplify the definition of 'soft deprecated' (GH-124988) (#125030)

(cherry picked from commit feca4cf64e9742b9c002d5533ced47e68b34a880)

Co-authored-by: Andrés Delfino <adelfino@gmail.com>
Co-authored-by: Sergey B Kirpichev <skirpichev@gmail.com>
Co-authored-by: Carol Willing <carolcode@willingconsulting.com>
---

diff --git a/Doc/glossary.rst b/Doc/glossary.rst
index f78701559307..b233967adc9e 100644
--- a/Doc/glossary.rst
+++ b/Doc/glossary.rst
@@ -1134,6 +1134,17 @@ Glossary
       when several are given, such as in ``variable_name[1:3:5]``.  The bracket
       (subscript) notation uses :class:`slice` objects internally.
 
+   soft deprecated
+      A soft deprecated API should not be used in new code,
+      but it is safe for already existing code to use it.
+      The API remains documented and tested, but will not be enhanced further.
+
+      Soft deprecation, unlike normal deprecation, does not plan on removing the API
+      and will not emit warnings.
+
+      See `PEP 387: Soft Deprecation
+      <https://peps.python.org/pep-0387/#soft-deprecation>`_.
+
    special method
       .. index:: pair: special; method