It's great that you document the args and give an example.  Mind formatting it in the numpy docstring style?

https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt

Then it will be picked up by our API docs.