Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DM-41700: Add plugin deprecation procedure #665

Merged
merged 1 commit into from
Apr 13, 2024
Merged

DM-41700: Add plugin deprecation procedure #665

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions stack/deprecating-interfaces.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,6 +132,14 @@ This can be achieved via preprocessor directives::

Note that this works for ``clang`` as well as ``gcc``, despite the pragma name.

Measurement Plugin Deprecation
------------------------------

Some of our measurement plugins are written in C++, as subclasses of `~lsst.meas.base.SimpleAlgorithm`.
To deprecate such a C++ plugin, follow the C++ deprecation procedure above for the C++ header declaration, being sure to catch each of the ``Control``, ``Algorithm``, and ``Transform`` classes.
In addition, where the algorithm class is registered to the plugin algorithm registry via `~lsst.meas.base.wrapSimpleAlgorithm` (for example, from ``plugins.py`` in ``meas_base`` for plugins defined in that package), add a ``deprecated="Plugin 'XXXX' is deprecated and will be removed after vXX."`` kwarg to the ``wrapSimpleAlgorithm`` call.
This will ensure that any pipeline that is configured to use this plugin will emit a deprecation warning about the plugin during initialization.

Config Deprecation
==================

Expand Down
Loading