This would make a good docstring. In general, you can surround function-describing comments like these in `"""`, strip off the number signs, and thus let code reflection and documentation tools like Sphinx better enjoy the code.