mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-07-24 11:44:31 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 8

Doc: update PendingDeprecationWarning explanation (GH-12837)

Browse source 
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
1 changed files with 6 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

15
Doc/library/exceptions.rst
View file

@ -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