Commit a3283efd authored by Inada Naoki's avatar Inada Naoki Committed by Nick Coghlan

Doc: update PendingDeprecationWarning explanation (GH-12837)

Keep the nudge towards DeprecationWarning, but remove the
"Note" markup and generally shorten the description.

Ref: https://github.com/python/cpython/pull/12505/files#r273978757
parent a9a28808
......@@ -691,16 +691,13 @@ The following exceptions are used as warning categories; see the
.. exception:: PendingDeprecationWarning
Base class for warnings about features which will be deprecated in the
future.
Base class for warnings about features which are obsolete and
expected to be deprecated in the future, but are not deprecated
at the moment.
.. note::
PendingDeprecationWarning was introduced as an "ignored by default"
version of DeprecationWarning. But :exc:`DeprecationWarning` is also
ignored by default since Python 2.7 and 3.2.
There is not much difference between PendingDeprecationWarning and
DeprecationWarning nowadays. DeprecationWarning is recommended
in general.
This class is rarely used as emitting a warning about a possible
upcoming deprecation is unusual, and :exc:`DeprecationWarning`
is preferred for already active deprecations.
.. exception:: SyntaxWarning
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment