search

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
133 stars 65 forks source link

Remove leading underscores from all module names? #870

Closed hoechenberger closed 4 months ago

hoechenberger commented 4 months ago

I believe we had initially introduced those underscores when we converted the pipeline from scripts that would be invoked directly by the user (or through a Makefile or something similar, I don't remember) to mere modules that are run through a parent script (now: _run.py). This was also before we turned the pipeline into an installable package with a CLI entry point.

Since the only supported use-case of the pipeline now is through CLI invocation, I'd be in favor of removing all those underscrores from all modules, as they're not really needed anymore.

WDYT?

larsoner commented 4 months ago

IIRC you can't have a Python module name start with a number

larsoner commented 4 months ago

... So for the steps at least I don't think we can. For stuff like _run.py I like that is clear that it's private currently, it's fairly standard scientific python ecosystem practice nowadays. Otherwise in the docs we'd need to make it clear that we are an exception to the rule: everything is considered private except the CLI, which people could miss. And then if we do remove the ones we can, it'll also be weird that only our step names do have underscores. So I think I'm -0.5 on removing them but can live with it if you want to

hoechenberger commented 4 months ago

Ok, this was just an idea. Let's leave it for now