Skip to content

Commit

Permalink
Merge pull request #697 from lsst-dm/tickets/DM-44612
Browse files Browse the repository at this point in the history
DM-44612: Add an explicit example deprecating a class
  • Loading branch information
arunkannawadi authored Oct 4, 2024
2 parents 5358c56 + 7938a63 commit 4469016
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion stack/deprecating-interfaces.rst
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,14 @@ If you need to deprecate a class or function, import the `~deprecated.sphinx.dep

from deprecated.sphinx import deprecated

For each class or function to be deprecated, decorate it as follows::
For each class to be deprecated, decorate it as follows::

@deprecated(reason="The MakeWarpTask is replaced by MakeDirectWarpTask and MakePsfMatchedWarpTask. "
"This Task will be removed after v28.",
version="v28.0", category=FutureWarning)
class MakeWarpTask(CoaddBaseTask):

and for each function to be deprecated, decorate it similarly as follows::

@deprecated(reason="This method is no longer used for ISR. Will be removed after v14.",
version="v14.0", category=FutureWarning)
Expand Down

0 comments on commit 4469016

Please sign in to comment.