Skip to content

Commit feca4cf

Browse files
andresdelfinoAA-Turnerskirpichevwillingc
authored
Doc: Simplify the definition of 'soft deprecated' (#124988)
Co-authored-by: Adam Turner <[email protected]> Co-authored-by: Sergey B Kirpichev <[email protected]> Co-authored-by: Carol Willing <[email protected]>
1 parent a1be83d commit feca4cf

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
@@ -1160,16 +1160,12 @@ Glossary
11601160
(subscript) notation uses :class:`slice` objects internally.
11611161

11621162
soft deprecated
1163-
A soft deprecation can be used when using an API which should no longer
1164-
be used to write new code, but it remains safe to continue using it in
1165-
existing code. The API remains documented and tested, but will not be
1166-
developed further (no enhancement).
1163+
A soft deprecated API should not be used in new code,
1164+
but it is safe for already existing code to use it.
1165+
The API remains documented and tested, but will not be enhanced further.
11671166

1168-
The main difference between a "soft" and a (regular) "hard" deprecation
1169-
is that the soft deprecation does not imply scheduling the removal of the
1170-
deprecated API.
1171-
1172-
Another difference is that a soft deprecation does not issue a warning.
1167+
Soft deprecation, unlike normal deprecation, does not plan on removing the API
1168+
and will not emit warnings.
11731169

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

0 commit comments

Comments
 (0)