General helper functions

Small helper and utilities functions that don’t fit anywhere else.

scatterkit.lib.util.DOC_DICT

Dictionary containing the keys and the actual docstring used by scatterkit.lib.util.render_docs().

scatterkit.lib.util.render_docs(func: Callable) → Callable

Replace all template phrases in the functions docstring.

Keys for the replacement are taken from in scatterkit.lib.util.DOC_DICT.

Parameters:

func (callable) – The callable (function, class) where the phrase old should be replaced.

Returns:

callable with replaced phrase

Return type:

Callable