Skip to content

Commit d7e4c79

Browse files
miss-islingtonandresdelfinoAA-Turnerskirpichevwillingc
authored
[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 feca4cf) 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]>
1 parent b30da22 commit d7e4c79

File tree

1 file changed

+5
-9
lines changed

1 file changed

+5
-9
lines changed

Doc/glossary.rst

+5-9
Original file line numberDiff line numberDiff line change
@@ -1150,16 +1150,12 @@ Glossary
11501150
(subscript) notation uses :class:`slice` objects internally.
11511151

11521152
soft deprecated
1153-
A soft deprecation can be used when using an API which should no longer
1154-
be used to write new code, but it remains safe to continue using it in
1155-
existing code. The API remains documented and tested, but will not be
1156-
developed further (no enhancement).
1153+
A soft deprecated API should not be used in new code,
1154+
but it is safe for already existing code to use it.
1155+
The API remains documented and tested, but will not be enhanced further.
11571156

1158-
The main difference between a "soft" and a (regular) "hard" deprecation
1159-
is that the soft deprecation does not imply scheduling the removal of the
1160-
deprecated API.
1161-
1162-
Another difference is that a soft deprecation does not issue a warning.
1157+
Soft deprecation, unlike normal deprecation, does not plan on removing the API
1158+
and will not emit warnings.
11631159

11641160
See `PEP 387: Soft Deprecation
11651161
<https://peps.python.org/pep-0387/#soft-deprecation>`_.

0 commit comments

Comments
 (0)