mne-tools / mne-bids-pipeline

Automatically process entire electrophysiological datasets using MNE-Python.
https://mne.tools/mne-bids-pipeline/
BSD 3-Clause "New" or "Revised" License
138 stars 66 forks source link

enhance documentation of caching, continuation of #914 #918

Closed SophieHerbst closed 6 months ago

SophieHerbst commented 6 months ago

Before merging …

hoechenberger commented 6 months ago

While we're talking caching … I would love to have all those parameters named cache_* and not memory_*.

Thoughts?

@larsoner

larsoner commented 6 months ago

Okay with me, I doubt they are widely used and we can avoid issues by explicitly disallowing the old names:

https://github.com/mne-tools/mne-bids-pipeline/blob/d8c1e4b683f45567f0c1aad59ab87c89355bf34b/mne_bids_pipeline/_config_import.py#L404

larsoner commented 6 months ago

Just adding a cross-ref to #916 since once we document the command-line options we should ideally cross-link the --no-cache in this PR to it

larsoner commented 6 months ago

Thanks @SophieHerbst !