bilby.core.utils.docs.docstring

bilby.core.utils.docs.docstring(docstr, sep='\n')[source]

Decorator: Append to a function’s docstring.

This is required for e.g., classmethods as the __doc__ can’t be changed after.

Parameters:
docstr: str

The docstring

sep: str

Separation character for appending the existing docstring.