torch_ecg.utils.add_docstring#
- torch_ecg.utils.add_docstring(doc: str, mode: Literal['replace', 'append', 'prepend'] = 'replace') Callable[source]#
Decorator to add docstring to a function or a class.
- Parameters:
doc (str) – The docstring to be added.
mode ({"replace", "append", "prepend"}, default "replace") – The mode of the adding to the original docstring, case insensitive.