mne-python icon indicating copy to clipboard operation
mne-python copied to clipboard

Change known_config_types to dict

Open cbrnr opened this issue 1 year ago • 5 comments

Fixes #11164. I think this is all that's needed structurally, now the only problem I have is that I don't know what even half of these options mean. In addition, we should use a consistent style when describing each option, mentioning the default and the type of each value. Finally, I am not sure how we should best deal with those long lines, because wrapping them to 79 chars will be a mess.

So if anyone wants to take over I'd be more than happy!

cbrnr avatar Sep 15 '22 15:09 cbrnr

I've wrapped the lines black-style. I'm OK with the proposed description style, the only thing I'd add is the default at the end.

cbrnr avatar Sep 16 '22 06:09 cbrnr

I'm also wondering why almost all keys are prefixed with MNE_ – why? It would be easier if we just removed this prefix.

cbrnr avatar Sep 16 '22 06:09 cbrnr

I'm also wondering why almost all keys are prefixed with MNE_ – why? It would be easier if we just removed this prefix.

because these are also used as environment variables. If we call our environment variables things like CACHE_DIR or DATA we can't safely assume that other programs won't mess with them.

drammock avatar Sep 16 '22 13:09 drammock

Re MNE_ prefix, what about SUBJECTS_DIR?

cbrnr avatar Sep 16 '22 14:09 cbrnr

That one we adopted from FreeSurfer so it wasn't ours to name

larsoner avatar Sep 16 '22 15:09 larsoner