summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>2024-10-06 23:04:43 (GMT)
committerGitHub <noreply@github.com>2024-10-06 23:04:43 (GMT)
commitd7e4c790ffafe0cd886101b2aa25533a1ec2bb6d (patch)
tree6c2d9131c34a692d0e55919de9d5ec5210956a5c
parentb30da225cfe86f22d0d838af2c15908277191608 (diff)
downloadcpython-d7e4c790ffafe0cd886101b2aa25533a1ec2bb6d.zip
cpython-d7e4c790ffafe0cd886101b2aa25533a1ec2bb6d.tar.gz
cpython-d7e4c790ffafe0cd886101b2aa25533a1ec2bb6d.tar.bz2
[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 <adelfino@gmail.com> 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>
-rw-r--r--Doc/glossary.rst14
1 files changed, 5 insertions, 9 deletions
diff --git a/Doc/glossary.rst b/Doc/glossary.rst
index 97cee07..17461e2 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>`_.