:py:mod:`profiley.helpers.decorators`
=====================================

.. py:module:: profiley.helpers.decorators


Submodules
----------
.. toctree::
   :titlesonly:
   :maxdepth: 1

   base/index.rst


Package Contents
----------------


Functions
~~~~~~~~~

.. autoapisummary::

   profiley.helpers.decorators.array
   profiley.helpers.decorators.deprecated
   profiley.helpers.decorators.float_args
   profiley.helpers.decorators.inMpc



.. py:function:: array(f)

   Add dimensions to the first argument, assumed to be the radial coordinate at
   which a given profile will be calculated, to match the ``Profile`` object shape


.. py:function:: deprecated(since='', instead='', category=DeprecationWarning)


.. py:function:: float_args(f)

   Test whether all arguments are float (or None)


.. py:function:: inMpc(f)

   Change units of a Quantity to Mpc and return a float.