Docstring in Python

Things on this page are fragmentary and immature notes/thoughts of the author. Please read with your own judgement!

Tips and Traps¶

I personal prefer the sphnix style as it is concise and work well with type annotation.
Improperly escaped \n in docstring causes darglint fail to parse the docstring.