search

spacepy / dbprocessing

Automated processing controller for heliophysics data
5 stars 4 forks source link

Document standards for variable names, etc. #35

Open jtniehof opened 3 years ago

jtniehof commented 3 years ago

There's a pretty wide range of variable names used for e.g. file ids and file records and the like; it would help the codebase be more readable if we set standards for these. E.g. a file ID is always referred to as file_id instead of fid or fileID unless it needs to be more specific. (I'm not choosing file_id over the others, we should just pick one to be consistent.)

Closure condition

This issue should be closed when: standards agreed on and documented in the Sphinx docs in a merged PR. No need to "fix" all the code to the new standard immediately.

balarsen commented 3 years ago

You mean you are tired of my totally inconsistent use of camel case And underscores

jtniehof commented 3 years ago

Actually it's more that I'm tired of my inconsistent use of camel_case and UnderScores and I want to tie myself to something.