bundles / scipy 2.0.0.dev0+git20260907.41eeb59 / scipy / _lib / doccer / filldoc

function

`scipy._lib.doccer:filldoc`

source: build-install/usr/lib/python3.14/site-packages/scipy/_lib/doccer.py:263

Signature

def filldoc(docdict: Mapping[str, str], unindent_params: bool = True) → Decorator

Summary

Return docstring decorator using docdict variable dictionary.

Parameters

docdict : dict[str, str]: A dictionary containing name, docstring fragment pairs.
unindent_params : bool, optional: If True, strip common indentation from all parameters in docdict. Default is False.

Returns

decfunc : function: The decorator function that applies dictionary to its argument's __doc__ attribute.

Aliases

scipy.signal._filter_design.doccer.filldoc