-
Notifications
You must be signed in to change notification settings - Fork 1
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
rmv redundant prefix #5
Comments
Can you also not use real neuroscientist's names? It might imply an endorsement that we don't really have. Could you use fictional or historical characters? Like Plato or Bruce Banner |
Yeah that's a good point, we should not be doing that. I always endorse the classic anonymous naming scheme for this kind of thing: John & Jane Doe. Not as fun as Marvel characters, I know, but it's the most professional/legal IMO. |
yeah, we could probably get away with it but no need to cause any potential legal issues with Disney. Maybe stick to public domain, historical, or stock names like Jane Doe |
As for the heart of the question on this issue, I believe the justification is two-fold: (a) The name of the Python file mirrors the name of the single class definition that it contains, just like any of our interfaces in the core NeuroConv. That is, the file This class should always have a prefix that indicates it's specific use to the very specific experiment setup, and will typically mirror the prefix of the corresponding custom (b) Given (a), if the file containing this class became misplaced accidentally (even within the same project) it is easier to overlook such a misplacement when the file stem itself has something that indicates this specificity rather than having to introspect the file contents to guess. This philosophy is similar to the DANDI organization, where the name of each NWB file contains the session and subject IDs for that file in addition to the file being nested within folders whose names also contain that information |
Also worth mentioning, with regards to (a) in the past I've always tried to use the smallest prefix possible that keeps things in the repo unique, and can always be changed on the fly (keep is simple on first cookiecut, then extend over time on the repo). This came up a lot in the Buzsaki repo where most experimenters only had one big paper that the data corresponded to, so I'd usually just set the prefix to be the last name of that experimenter. Additional info would like year of the paper publication or differentiating subject matter of the paper would only be added to the last name if the author had or in this case was expecting to have more publications. So |
can we change this to:
|
Can we remove the "brenda_milner_2022" prefix from brenda_milner_2022behaviorinterface.py etc.? It's redundant if these files are already in the brenda_milner_2022 directory
The text was updated successfully, but these errors were encountered: