Skip to content

Commit 15ee31f

Browse files
committed
pythongh-106535: Document PEP 387 Soft Deprecation
1 parent 6e6a4cd commit 15ee31f

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

Doc/glossary.rst

+15
Original file line numberDiff line numberDiff line change
@@ -1107,6 +1107,21 @@ Glossary
11071107
when several are given, such as in ``variable_name[1:3:5]``. The bracket
11081108
(subscript) notation uses :class:`slice` objects internally.
11091109

1110+
soft deprecated
1111+
A soft deprecation can be used when using an API which should no longer
1112+
be used to write new code, but it remains safe to continue using it in
1113+
existing code. The API remains documented and tested, but will not be
1114+
developed further (no enhancement).
1115+
1116+
The main difference between a "soft" and a (regular) "hard" deprecation
1117+
is that the soft deprecation does not imply scheduling the removal of the
1118+
deprecated API.
1119+
1120+
Another difference is that a soft deprecation does not issue a warning.
1121+
1122+
See `PEP 387: Soft Deprecation
1123+
<https://peps.python.org/pep-0387/#soft-deprecation>`_.
1124+
11101125
special method
11111126
.. index:: pair: special; method
11121127

0 commit comments

Comments
 (0)