smpl_doc.doc.append_str

smpl_doc.doc.append_str(txt)

Append txt in the target function docstring.

Parameters

txtstr

txt is inserted to the __doc__ of the target

Examples

>>> def ho():
...     '''Ho'''
...     print(ho.__doc__)
>>> @append_doc(ho)
... def hi():
...     '''Hi'''
...     print(hi.__doc__)
>>> hi()
HiHo