help_str

PlasmaCalcs.tools.pytools.help_str(f, *, module=True, blankline=True, signature=True, doc=True, indent='')

return str for help(f).

module: bool

whether to include line with module name in help string.

e.g. “function help_str in module PlasmaCalcs.tools.pytools”

blankline: bool

whether to include blank line between module and signature.

only considered if module=True AND signature=True.

signature: bool

whether to include line with signature in help string.

e.g. “help_str(f, *, module=True, signature=True, indent=None)”

doc: bool

whether to include lines with docstring in help string.

e.g. “return str for help(f).” … and all the other docs in here.

indent: str

indent all lines in the result by this string.

equivalent to textwrap.indent(result, indent).