From time to time we need to deprecate functionality, this is a guide as to how we implement deprecation.
Toolkit retains deprecated features for a period of two releases. Thus features deprecated in 1.7.0 are removed in 1.9.0.
@deprecated decorator with a comment and change the docstring to
use the Sphinx deprecation syntax.
@deprecated("Use util.run_fast() instead.") def run_slow(): """Run slowly .. deprecated:: 1.9.0 Use :func:`run_fast` instead. """ run_fast() # Call new function if possible
Deprecated features should call the new functionality if possible. This may not always be possible, such as the cases of drastic changes. But it is the preferred approach to reduce maintenance of the old code.
This applies only to feature deprecation and renamed functions. Announcements for corrections are at the coders discretion.
On first release with deprecation highlight that the feature is deprecated in this release and explain reasons and alternate approaches.
On second relase warn that the feature will be removed in the next release.
On third release remove the feature and announce removal in the release announcements.
Thus by examples:
run_slow function has been deprecated and replaced by the faster and
run_fast. Users of
run_slow are advised to migrate
run_slow function has been deprecated and replaced by
and will be removed in the next version. Users of
run_slow are advised
to migrate their code.
run_slow function has been removed, use