Rename temporal_derivative_distribution_repair to tddr
See original GitHub issueCan we rename temporal_derivative_distribution_repair
to just tddr
? I really think that the function name is too long (39 characters) - it makes it impossible to stay within the 79 character limit without using ugly \
line breaks, e.g.:
from mne.preprocessing.nirs import temporal_derivative_distribution_repair as tddr # 82 characters
I think renaming to tddr
is not problematic because the function is in the nirs
subpackage, and TDDR is a commonly known abbreviation in the NIRS community (googling for “nirs tddr” immediately brings up several results with the correct method).
This issue came up in https://github.com/cbrnr/mnelab/pull/145 that @rob-luke is working on. He’d probably be fine with renaming because that’s what he initially proposed.
And while we’re at it, I’d like to rename beer_lambert_law
to beer_lambert
as well (we’d save 4 chars without losing any meaning).
Issue Analytics
- State:
- Created 3 years ago
- Comments:38 (38 by maintainers)
Top GitHub Comments
Let’s do the alias, it allows the shortest-name and longest-name to be maximally happy
There is much more information in the name than the acronym. It tells me it acts on temporal information, that it repairs the signal based on distribution information.
If I put myself in the role of supervisor and am reviewing a students code where they have used a new approach i don’t know (this happens lots that students find the latest thing that I didn’t know about). While skimming through a students code looking for why the output looks strange, if I see the words repair and temporal it will inform me about what was done. Tddr will not. I’m aware I can read the docs, but sometimes I’m rushed.
I think votes have been cast. There is no correct decision here. Someone just needs to make a decision, I’m new to MNE and don’t know the system, so will leave this to more experienced developers. I’ve appreciated the discussion though.