From fe92808a00551f975934c675d41b809492b681de Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Andr=C3=A9s=20Delfino?= Date: Sun, 6 Oct 2024 19:22:19 -0300 Subject: [PATCH] [3.12] Doc: Simplify the definition of 'soft deprecated' (GH-124988) (cherry picked from commit feca4cf64e9742b9c002d5533ced47e68b34a880) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Andrés Delfino Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com> Co-authored-by: Sergey B Kirpichev Co-authored-by: Carol Willing --- Doc/glossary.rst | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/Doc/glossary.rst b/Doc/glossary.rst index f78701559307939..b233967adc9e6a5 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 + `_. + special method .. index:: pair: special; method