Skip to content
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

PEP-8 compliant naming of files and modules #63

Closed
drcandacemakedamoore opened this issue Mar 18, 2024 · 1 comment
Closed

PEP-8 compliant naming of files and modules #63

drcandacemakedamoore opened this issue Mar 18, 2024 · 1 comment
Assignees
Labels
enhancement New feature or request
Milestone

Comments

@drcandacemakedamoore
Copy link

Preferably module names should be all lower case (and super-best is single word or if no other choice with underscore). I notice you have modules that are camelcase. Different file systems have different case conventions. The real point is that it could be possible to import these modules in two different ways then cause problems on different files systems where case conventions are different.

@alexzwanenburg alexzwanenburg added the enhancement New feature or request label Mar 18, 2024
@alexzwanenburg alexzwanenburg added this to the v2.2.0 milestone Mar 18, 2024
@alexzwanenburg
Copy link
Member

alexzwanenburg commented Mar 18, 2024

Thanks for raising this point. The naming of modules was done with mixed case for historical reasons. Though we have experienced no problems operating MIRP on Linux or Windows platforms, PEP 8 does recommend lowercase names for modules.

This is moreover a good opportunity to appropriately make most modules private, in the sense that modules are not intended to be public-facing.

openjournals/joss-reviews#6413

@alexzwanenburg alexzwanenburg self-assigned this Mar 18, 2024
@alexzwanenburg alexzwanenburg changed the title File system problem prevention PEP-8 compliant naming of files and modules Mar 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants