Skip to content
Permalink
443bfd0205
Switch branches/tags
Go to file
 
 
Cannot retrieve contributors at this time
25 lines (16 sloc) 604 Bytes

The sloth API

.. module:: sloth

Most of the code is kept in submodules, not the sloth namespace. Eg timers are in the sloth.timers module. The only function in the main sloth namespace is compare_sloth, which is documented below.

.. toctree::
   :maxdepth: 2
   :caption: API

   timers
   simple
   raw/index


.. py:function:: compare_sloth(against)

    Returns a string which is the result of comparing ``sloth`` to *against*.

    :param module against: Module/Package to compare sloth to.

    :returns: String describing ``sloth`` vs *against*
    :rtype: str