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
This commit is contained in:
Inada Naoki 2019-04-15 21:40:23 +09:00 committed by Nick Coghlan
parent a9a28808e5
commit a3283efd30

View file

@ -691,16 +691,13 @@ The following exceptions are used as warning categories; see the
.. exception:: PendingDeprecationWarning .. exception:: PendingDeprecationWarning
Base class for warnings about features which will be deprecated in the Base class for warnings about features which are obsolete and
future. expected to be deprecated in the future, but are not deprecated
at the moment.
.. note:: This class is rarely used as emitting a warning about a possible
PendingDeprecationWarning was introduced as an "ignored by default" upcoming deprecation is unusual, and :exc:`DeprecationWarning`
version of DeprecationWarning. But :exc:`DeprecationWarning` is also is preferred for already active deprecations.
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.
.. exception:: SyntaxWarning .. exception:: SyntaxWarning