:py:mod:`maha.deprecation`
==========================

.. py:module:: maha.deprecation


Module Contents
---------------


Functions
~~~~~~~~~

.. autosummary::

   deprecated_fn
   deprecated_param
   deprecated_default



.. py:function:: deprecated_fn(from_v, to_v, alt_fn, message = '')

   Decorator to mark a function as deprecated.

   :param from_v: Version from since the function is deprecated
   :type from_v: str
   :param to_v: Version from which the function is removed
   :type to_v: str
   :param alt_fn: New function to replace the deprecated function
   :type alt_fn: str
   :param message: Message to display when the function is called
   :type message: str

   :returns: The decorated function
   :rtype: function


.. py:function:: deprecated_param(from_v, to_v, depr_param, alt_param = None, message = '')

   Decorator to mark a parameter as deprecated.

   :param from_v: Version since which the parameter is deprecated
   :type from_v: str
   :param to_v: Version from which the parameter is removed
   :type to_v: str
   :param depr_param: Parameter to deprecate
   :type depr_param: str
   :param alt_param: Parameter to use instead
   :type alt_param: str
   :param message: Message to display when the function is called
   :type message: str

   :returns: The decorated function
   :rtype: function


.. py:function:: deprecated_default(from_v, to_v, depr_param, alt_value = None, message = '')

   Decorator to mark a parameter default value as deprecated.

   :param from_v: Version since which the parameter is deprecated
   :type from_v: str
   :param to_v: Version from which the parameter is removed
   :type to_v: str
   :param depr_param: Parameter to deprecate its default value
   :type depr_param: str
   :param alt_value: New default value that will used instead
   :type alt_value: str
   :param message: Message to display when the function is called
   :type message: str

   :returns: The decorated function
   :rtype: function