summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorInada Naoki <songofacandy@gmail.com>2019-04-05 08:54:24 (GMT)
committerGitHub <noreply@github.com>2019-04-05 08:54:24 (GMT)
commit176d26364bb67801fa522f52f20cbe44420d6942 (patch)
treefce0e97e857806e6e2f95573a00aef4b61baebdc
parent2a4ce4387ff3e2b41c474e2b0522c8164162cafb (diff)
downloadcpython-176d26364bb67801fa522f52f20cbe44420d6942.zip
cpython-176d26364bb67801fa522f52f20cbe44420d6942.tar.gz
cpython-176d26364bb67801fa522f52f20cbe44420d6942.tar.bz2
bpo-36404: recommend DeprecationWarning over PendingDeprecationWarning (GH-12505)
-rw-r--r--Doc/library/exceptions.rst8
-rw-r--r--Doc/library/warnings.rst10
2 files changed, 13 insertions, 5 deletions
diff --git a/Doc/library/exceptions.rst b/Doc/library/exceptions.rst
index 57ed291..2509380 100644
--- a/Doc/library/exceptions.rst
+++ b/Doc/library/exceptions.rst
@@ -694,6 +694,14 @@ The following exceptions are used as warning categories; see the
Base class for warnings about features which will be deprecated in the
future.
+ .. 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.
+
.. exception:: SyntaxWarning
diff --git a/Doc/library/warnings.rst b/Doc/library/warnings.rst
index b04bd79..d121f32 100644
--- a/Doc/library/warnings.rst
+++ b/Doc/library/warnings.rst
@@ -109,11 +109,11 @@ The following warnings category classes are currently defined:
+----------------------------------+-----------------------------------------------+
.. versionchanged:: 3.7
- Previously :exc:`DeprecationWarning` and :exc:`FutureWarning` were
- distinguished based on whether a feature was being removed entirely or
- changing its behaviour. They are now distinguished based on their
- intended audience and the way they're handled by the default warnings
- filters.
+ Previously :exc:`DeprecationWarning` and :exc:`FutureWarning` were
+ distinguished based on whether a feature was being removed entirely or
+ changing its behaviour. They are now distinguished based on their
+ intended audience and the way they're handled by the default warnings
+ filters.
.. _warning-filter: