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

Clean up of directories, variable names, file organization, etc #53

Open
4 of 6 tasks
mattsignorelli opened this issue Sep 17, 2024 · 1 comment
Open
4 of 6 tasks

Comments

@mattsignorelli
Copy link
Contributor

mattsignorelli commented Sep 17, 2024

I'm going through the directories now and feel there is a lot of convention clean up needed:

  • CamelCase for file names should be reserved for Modules. For non-modules, just use snake_case
  • Choose either snake-case or camel case, but not both, e.g. Subatomic_Particles dictionary
  • All exports should be included near the top of AtomicAndPhysicalConstants.jl, not spread throughout the files
  • Clarification of global constants, e.g. is Subatomic_Particles a global constant? If so, add const and call it SUBATOMIC_SPECIES for example (all caps snake-case for constants is my personal preference)
  • Files and variable locations should be reorganized into some cleaner layout. For example, one way is to put constructors for each struct right underneath the struct definition. An alternative is to have a file called ctors.jl for example containing the constructors.
  • Change AbstractString -> String? I don't see much benefit in allowing weird other kinds of strings. This is to improve type-stability of dictionary accessing
@rot4te
Copy link
Collaborator

rot4te commented Sep 18, 2024

I'm checking these off while I work on them, not necessarily pushed yet

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants