Nice to see some documentation on the function. You could write this up like python function documentation, there is a plugin for doxygen to handle that.