Open jessecusack opened 11 months ago
I'm slowly switching to snake case, and we can migrate naming conventions to be roughly in agreement with the "community guidelines" Jesse linked to.
For a prefix, I have been using osgl_, Oregon State Glider Lab, for my other public packages. We can use that, or come up with something else. But yes, it would be a good idea for code isolation.
I don't like osgl, but happy to brainstorm other options.
Following our meeting this morning, here are our goals for this package:
Important, but secondary goals:
Things to think about down the road
Code style
I don't have a strong preference for camel case or snake case, but I want us to be consistent. We may want to consider following matlab community guidelines: https://sites.google.com/site/matlabstyleguidelines/naming-conventions/functions
We may want to consider appending some tag to our function names, like m_map and gsw do (e.g. m_plot, gsw_Nsquared) to easily identify our functions and avoid namespace conflicts.