Appender#
- class Appender[source]#
Append addendum to the docstring.
A function decorator that will append an addendum to the docstring of the target function.
This decorator should be robust even if func.__doc__ is None
Usage: construct a docstring.Appender with a string to be joined to the original docstring. An optional ‘join’ parameter may be supplied which will be used to join the docstring and addendum. e.g.
add_copyright = Appender(“Copyright (c) 2009”, join=’n’)
@add_copyright def my_dog(has=’fleas’):
“This docstring will have a copyright below” pass
- __new__(*args, **kwargs)#
Attributes
Methods