debtcollector/doc/source/api.rst
Matthew Treinish 497c1b47be Add a removal decorator
This commit adds a new decorator to mark a function/class as
deprecated in preparation for it's removal.

Change-Id: I4c3cf3ff9abdd7faefeae907a8b73608123fb09d
2015-02-09 22:54:57 +00:00

29 lines
515 B
ReStructuredText

===
API
===
The currently documented publicly exposed API's for usage in your project
are defined below.
.. warning::
External usage of internal utility functions and modules should be kept
to a **minimum** as they may be altered, refactored or moved to other
locations **without** notice (and without the typical deprecation cycle).
Moves
-----
.. automodule:: debtcollector.moves
Renames
-------
.. automodule:: debtcollector.renames
Removals
--------
.. automodule:: debtcollector.removals