search

WasatchPhotonics / ENLIGHTEN

Open-source spectroscopy application for controlling and taking measurements from Wasatch Photonics spectrometers.
https://wasatchphotonics.com/product-category/software/
MIT License
3 stars 6 forks source link

allow SRM in Expert Mode #277

Closed mzieg closed 12 months ago

mzieg commented 1 year ago
samiebee43 commented 12 months ago

I meant actually a three line comment on 1827 of Controller.

Thanks for taking the time to document PageNav class, but generally I want to avoid long discussions in comments, as they can distract from the code itself.

I prefer 5-10 lines for class strings, 3-7 for functions, and 1-3 for inline.

I've mentioned this elsewhere, I believe longer comments are more relevant in systems or driver code, such as Wasatch.PY -- I would like to keep longer descriptions or discussions about design in peripheral documents such as Google Drive, Wiki, or GH discussions.

I'm fine to leave your change to PageNav as it is for this merge, but can we also add the three line comment I suggested to Controller?