Deprecation messages should include the removal date.

This commit is contained in:
Benjamin Peterson 2020-05-27 21:47:38 -05:00
parent 434d3c4800
commit f33bd6de86
1 changed files with 3 additions and 1 deletions

View File

@ -102,7 +102,9 @@ releases:
warn whenever it is entered. ``DeprecationWarning`` is the usual
warning category to use, but ``PendingDeprecationWarning`` may be
used in special cases were the old and new versions of the API will
coexist for many releases.
coexist for many releases. The warning message should include the
release the incompatibility is expected to become the default and a
link to an issue that users can post feedback to.
3. Wait for the warning to appear in at least two major Python
versions. It's fine to wait more than two releases.