A very similar question is already asked here: Docstrings when nothing is returned
but I would like to ask the same question with Numpy Docstrings.
For example:
from typing import NoReturn
def stop() -> NoReturn:
"""
Returns
-------
NoReturn
"""
raise RuntimeError()
What is the most convenient way to write Numpy Docstring "no return" type?
Is it preferable using void
or -
or blank or maybe something else?
For your information nothing is detailed about this in https://numpydoc.readthedocs.io/en/latest/format.html#returns