From: Inada Naoki <songofacandy@gmail.com>
Date: Mon, 15 Apr 2019 12:40:23 +0000 (+0900)
Subject: Doc: update PendingDeprecationWarning explanation (GH-12837)
X-Git-Tag: v3.8.0a4~176
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=a3283efd30ad52b56d1046138523cbabc6c69daf;p=thirdparty%2FPython%2Fcpython.git

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

diff --git a/Doc/library/exceptions.rst b/Doc/library/exceptions.rst
index 250938003c07..52a505e0a0ff 100644
--- a/Doc/library/exceptions.rst
+++ b/Doc/library/exceptions.rst
@@ -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