smpl_doc.doc.deprecated

smpl_doc.doc.deprecated(version=None, deprecated_in=None, removed_in=None, reason=None, details=None)[source]

Decorator to mark a function as deprecated.

Parameters

versionstr: Version of the package when the function was deprecated.
deprecated_instr: Version of the package when the function was deprecated.
removed_instr: Version of the package when the function will be removed.
reasonstr: Reason for deprecation.
detailsstr: Details about the deprecation.

Examples

>>> @deprecated('0.0.0',removed_in='0.2.0')
... def ho():
...     '''Ho'''
...     print(ho.__doc__)
>>> ho()
Ho

.. deprecated:: 0.0.0
   This will be removed in 0.2.0.