I get confused often about the right way to do inline docs. Should I write
:raises ValueError: if the message is too long
Also about the correct way to format return types and return strings.
I thought I would flush out the example in the docs a little more fully with examples of how to use :raises: so I can use this page as a reference in the future of how to do all of the things that autodoc domains support.
I would have liked to use an example from the Python docs or from Sphinx itself but I found one hard to find.