This API might be easier to understand if it has the standard formatting of the numpy API documentation. As part of this issue, if we are not going to follow numpy doc style, then recommend another.
References
- https://numpydoc.readthedocs.io/en/latest/format.html
- https://numpydoc.readthedocs.io/en/latest/example.html