xcp_d.utils.doc module

Functions related to the documentation.

docdict contains the standard documentation entries used across xcp_d.

source: Eric Larson and MNE-python team. https://github.com/mne-tools/mne-python/blob/main/mne/utils/docs.py

xcp_d.utils.doc.download_example_data(out_dir=None, overwrite=False)[source]

Download example data from Box.

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