search

yacobylab / oo_special_measure

new object oriented special measure
GNU General Public License v2.0
1 stars 0 forks source link

bad variable names #7

Open pmaher86 opened 10 years ago

pmaher86 commented 10 years ago

For now we can just note bad/confusing/overused variable names as we come across them. To start:

smdata: i propose renaming this to smrack, and reserve data for something that stores actual measurement data

inst (for the instrument gpib communication handle): commobj? insthand?

chan/channel: we should differentiate between a channel that belongs to an instrument (sminst.chan) and a channel that can be plugged into a measurement (smdata.chan). rackchan for the latter? instchan for the former?

jmmol commented 10 years ago

Great initiative! I would also recommend trying to use more explicit variable names in the future, which makes the code easier to read for newcomers. I am not sure if that many people have problems with this, but I got confused a lot of times, when I read through smrun and had to look up what dd, x, x2, xt and all this exactly was every single time. But it might as well just be me ;)