]> granicus.if.org Git - python/commitdiff
Doc: update PendingDeprecationWarning explanation (GH-12837)
authorInada Naoki <songofacandy@gmail.com>
Mon, 15 Apr 2019 12:40:23 +0000 (21:40 +0900)
committerNick Coghlan <ncoghlan@gmail.com>
Mon, 15 Apr 2019 12:40:23 +0000 (22:40 +1000)
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

Doc/library/exceptions.rst

index 250938003c078c733370d28a2c4e67ecbfad83ba..52a505e0a0ff8f17807a6a8990c11c8327e26e13 100644 (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