PlasmaCalcs.tools.docs_tools.format_docstring

PlasmaCalcs.tools.docs_tools.format_docstring(*args__format, sub_indent=None, sub_ntab=None, **kw__format)

returns a decorator of f which returns f, after updating f.__doc__ via f.__doc__.format(…)

sub_indent: None or str

if provided, indent all lines (after the first line) for each multiline string, before formatting.

sub_ntab: int

if provided when sub_indent is None, use sub_indent = sub_ntab * DEFAULTS.TAB.