mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-09-27 02:39:58 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 13

Doc: Simplify the definition of 'soft deprecated' (#124988)

Browse source 
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>
This commit is contained in:
Andrés Delfino 2024-10-06 19:22:19 -03:00 • committed by GitHub
parent a1be83dae3
commit feca4cf64e
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 5 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

14
Doc/glossary.rst
View file

@ -1160,16 +1160,12 @@ Glossary
(subscript) notation uses :class:`slice` objects internally. (subscript) notation uses :class:`slice` objects internally.
soft deprecated soft deprecated
A soft deprecation can be used when using an API which should no longer A soft deprecated API should not be used in new code,
be used to write new code, but it remains safe to continue using it in but it is safe for already existing code to use it.
existing code. The API remains documented and tested, but will not be The API remains documented and tested, but will not be enhanced further.
developed further (no enhancement).
The main difference between a "soft" and a (regular) "hard" deprecation Soft deprecation, unlike normal deprecation, does not plan on removing the API
is that the soft deprecation does not imply scheduling the removal of the and will not emit warnings.
deprecated API.
Another difference is that a soft deprecation does not issue a warning.
See `PEP 387: Soft Deprecation See `PEP 387: Soft Deprecation
<https://peps.python.org/pep-0387/#soft-deprecation>`_. <https://peps.python.org/pep-0387/#soft-deprecation>`_.