doc – Documentation

docstring – Docstring manipulation

Docstring manipulation tools

pyhetdex.doc.docstring.format_docstring(*args, **kwarg)

Decorator to allow string formating in docstrings using Format string syntax

Examples

>>> @format_docstring(a=10, b="hi")
... def foo():
...    "I want to say '{b}' {a} times"
...    pass
>>> foo.__doc__
"I want to say 'hi' 10 times"