clbarnes / jeiss-specs

Specifications of output format for "Jeiss" FIBSEMs
MIT License
2 stars 1 forks source link

Improve names #5

Open clbarnes opened 1 year ago

clbarnes commented 1 year ago

The LabView internal docs include units and more explicit names for the fields, which would be helpful to include. Kindly provided for v9 in this comment: https://github.com/JaneliaSciComp/jeiss_fibsem_labview_control/issues/11#issuecomment-1402995031 (note this does have some errors, e.g. file length is an int64 (signed, for some reason), not a float64).

Some design goals for names:

clbarnes commented 1 year ago

Notably, MATLAB style guidelines do not recommend UpperCamel: https://sites.google.com/site/matlabstyleguidelines/home?authuser=0

clbarnes commented 1 year ago

Proposed names and some other notes: https://docs.google.com/spreadsheets/d/1ZrfpneZqF5Bv7K5IVicyDBP3aAtEOK9Ma7RU_GwFK0s/edit?usp=sharing

clbarnes commented 1 year ago

Seeing more implementations in the wild with names further based on the MATLAB is making me lean away from this; I think the horse has bolted. I believe the best we could do would be to include a new column in the spec TSVs which describe fields and their units.