In the contributing guide document how to deprecate a feature
|Reported by:||timo||Owned by:||nobody|
|Has patch:||yes||Needs documentation:||no|
|Needs tests:||no||Patch needs improvement:||no|
Description (last modified by aaugustin)
Somewhere in internals/contributing we document guidelines for deprecating a feature. I couldn't find anything on this after a quick search.
This includes how to silence deprecation warnings:
When a feature is deprecated, it raises a PendingDeprecationWarning, either at import time or at run time. After the following release it raises DeprecationWarning. Assuming we have a good test coverage, these warnings will be shown by the test suite, with -Wall for PendingDeprecationWarning, or by default for DeprecationWarning. This is annoying. The output of the test suite should remain clean.
Aymeric's full post including how to silence warnings: