xcp_d.utils.doc.fill_doc

xcp_d.utils.doc.fill_doc(f)[source]

Fill a docstring with docdict entries.

Parameters:

f (callable) – The function to fill the docstring of. Will be modified in place.

Returns:

f – The function, potentially with an updated __doc__.

Return type:

callable