]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
[3.12] Doc: Simplify the definition of 'soft deprecated' (GH-124988) (#125030)
authorAdam Turner <9087854+AA-Turner@users.noreply.github.com>
Sun, 6 Oct 2024 22:42:11 +0000 (23:42 +0100)
committerGitHub <noreply@github.com>
Sun, 6 Oct 2024 22:42:11 +0000 (22:42 +0000)
(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>
Doc/glossary.rst

index f787015593079392581d21066c809ff625bf830d..b233967adc9e6a57206ab8d8ebf484d25251b442 100644 (file)
@@ -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