module

biopipen.utils.common_docstrs

</>

Common docstrings for biopipen procs.

Functions
function

biopipen.utils.common_docstrs.indent_docstr(docstr, indent)

</>

Indent the docstring.

Parameters
  • docstr (str) — The docstring.
  • indent (str) — The indent.
Returns (str)

The indented docstring.

function

biopipen.utils.common_docstrs.format_placeholder(**kwargs)

</>

A decorator to format a docstring placeholder.

Parameters
  • **kwargs — The docstring placeholder.
Returns (Callable)

The decorated function.