From: Andrés Delfino Date: Sun, 6 Oct 2024 22:22:19 +0000 (-0300) Subject: Doc: Simplify the definition of 'soft deprecated' (#124988) X-Git-Tag: v3.14.0a1~173 X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=feca4cf64e9742b9c002d5533ced47e68b34a880;p=thirdparty%2FPython%2Fcpython.git Doc: Simplify the definition of 'soft deprecated' (#124988) Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com> Co-authored-by: Sergey B Kirpichev Co-authored-by: Carol Willing --- diff --git a/Doc/glossary.rst b/Doc/glossary.rst index c9d3eba66b07..e72a8d002d50 100644 --- a/Doc/glossary.rst +++ b/Doc/glossary.rst @@ -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 `_.