https://github.com/python/cpython/commit/d7e4c790ffafe0cd886101b2aa25533a1ec2bb6d commit: d7e4c790ffafe0cd886101b2aa25533a1ec2bb6d branch: 3.13 author: Miss Islington (bot) <[email protected]> committer: Yhg1s <[email protected]> date: 2024-10-06T16:04:43-07:00 summary:
[3.13] Doc: Simplify the definition of 'soft deprecated' (GH-124988) (#125029) Doc: Simplify the definition of 'soft deprecated' (GH-124988) (cherry picked from commit feca4cf64e9742b9c002d5533ced47e68b34a880) Co-authored-by: Andrés Delfino <[email protected]> Co-authored-by: Adam Turner <[email protected]> Co-authored-by: Sergey B Kirpichev <[email protected]> Co-authored-by: Carol Willing <[email protected]> files: M Doc/glossary.rst diff --git a/Doc/glossary.rst b/Doc/glossary.rst index 97cee0755748cf2..17461e23e715570 100644 --- a/Doc/glossary.rst +++ b/Doc/glossary.rst @@ -1150,16 +1150,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>`_. _______________________________________________ Python-checkins mailing list -- [email protected] To unsubscribe send an email to [email protected] https://mail.python.org/mailman3/lists/python-checkins.python.org/ Member address: [email protected]
