]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
Doc: Simplify the definition of 'soft deprecated' (#124988)
authorAndrés Delfino <adelfino@gmail.com>
Sun, 6 Oct 2024 22:22:19 +0000 (19:22 -0300)
committerGitHub <noreply@github.com>
Sun, 6 Oct 2024 22:22:19 +0000 (22:22 +0000)
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: Sergey B Kirpichev <skirpichev@gmail.com>
Co-authored-by: Carol Willing <carolcode@willingconsulting.com>
Doc/glossary.rst

index c9d3eba66b07d92a1589360a69693da1305aaa08..e72a8d002d507db122607916e2fc2b14aa35a366 100644 (file)
@@ -1160,16 +1160,12 @@ Glossary
       (subscript) notation uses :class:`slice` objects internally.
 
    soft deprecated
-      A soft deprecation can be used when using an API which should no longer
-      be used to write new code, but it remains safe to continue using it in
-      existing code. The API remains documented and tested, but will not be
-      developed further (no enhancement).
+      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.
 
-      The main difference between a "soft" and a (regular) "hard" deprecation
-      is that the soft deprecation does not imply scheduling the removal of the
-      deprecated API.
-
-      Another difference is that a soft deprecation does not issue a warning.
+      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>`_.