Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 9 commits into from
Oct 6, 2024
Merged

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

Changes from 6 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
9393216
Simplify Soft deprecated definition
andresdelfino Oct 4, 2024
2281451
Simplify Soft deprecated definition
andresdelfino Oct 4, 2024
02de9c8
Update Doc/glossary.rst
andresdelfino Oct 4, 2024
3163124
Apply suggestions from code review
andresdelfino Oct 4, 2024
3665862
Merge branch 'main' into simplify_soft_deprecated
andresdelfino Oct 5, 2024
46287d4
Apply suggestions from code review
andresdelfino Oct 5, 2024
8b0d898
Update Doc/glossary.rst
andresdelfino Oct 6, 2024
f609818
Final edits
AA-Turner Oct 6, 2024
6f12c0f
Whitespace
AA-Turner Oct 6, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 6 additions & 8 deletions Doc/glossary.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1160,16 +1160,14 @@ 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.
The main difference from a normal deprecation is that soft
deprecation does not plan on removing the API.

Another difference is that a soft deprecation does not issue a warning.
Another difference is that soft deprecated APIs don't emit warnings.

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