diff options
| author | Inada Naoki <songofacandy@gmail.com> | 2019-04-15 12:40:23 (GMT) |
|---|---|---|
| committer | Nick Coghlan <ncoghlan@gmail.com> | 2019-04-15 12:40:23 (GMT) |
| commit | a3283efd30ad52b56d1046138523cbabc6c69daf (patch) | |
| tree | 21bd0cabdbae1f6494b08edadd729e3d7e11f1b1 | |
| parent | a9a28808e5a03d2e68e421227c113a38edc40946 (diff) | |
| download | cpython-a3283efd30ad52b56d1046138523cbabc6c69daf.zip cpython-a3283efd30ad52b56d1046138523cbabc6c69daf.tar.gz cpython-a3283efd30ad52b56d1046138523cbabc6c69daf.tar.bz2 | |
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
| -rw-r--r-- | Doc/library/exceptions.rst | 15 |
1 files changed, 6 insertions, 9 deletions
diff --git a/Doc/library/exceptions.rst b/Doc/library/exceptions.rst index 2509380..52a505e 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 |