From: Inada Naoki <songofacandy@gmail.com>
Date: Fri, 5 Apr 2019 08:54:24 +0000 (+0900)
Subject: bpo-36404: recommend DeprecationWarning over PendingDeprecationWarning (GH-12505)
X-Git-Tag: v3.8.0a4~263
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=176d26364bb67801fa522f52f20cbe44420d6942;p=python

bpo-36404: recommend DeprecationWarning over PendingDeprecationWarning (GH-12505)
---

diff --git a/Doc/library/exceptions.rst b/Doc/library/exceptions.rst
index 57ed291458..250938003c 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 b04bd79e4b..d121f320d6 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: