Skip to content

Commit

Permalink
pythongh-106535: Document PEP 387 Soft Deprecation (python#106536)
Browse files Browse the repository at this point in the history
Mark the optparse module as soft deprecated.
  • Loading branch information
vstinner authored Jul 7, 2023
1 parent 1fb9bd2 commit d524b6f
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 2 deletions.
15 changes: 15 additions & 0 deletions Doc/glossary.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1107,6 +1107,21 @@ Glossary
when several are given, such as in ``variable_name[1:3:5]``. The bracket
(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).

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.

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

special method
.. index:: pair: special; method

Expand Down
5 changes: 3 additions & 2 deletions Doc/library/optparse.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,9 @@
**Source code:** :source:`Lib/optparse.py`

.. deprecated:: 3.2
The :mod:`optparse` module is deprecated and will not be developed further;
development will continue with the :mod:`argparse` module.
The :mod:`optparse` module is :term:`soft deprecated` and will not be
developed further; development will continue with the :mod:`argparse`
module.

--------------

Expand Down

0 comments on commit d524b6f

Please sign in to comment.