andyvand / arduino

Automatically exported from code.google.com/p/arduino
Other
0 stars 0 forks source link

Change LiquidCrystal Example Comments for Clarity (No code changes) #1126

Open GoogleCodeExporter opened 9 years ago

GoogleCodeExporter commented 9 years ago
What change would like to see?

Within all LiquidCrystal examples a change from these 3 lines of comments:

 * 10K resistor:
 * ends to +5V and ground
 * wiper to LCD VO pin (pin 3)

to these 3 lines of comments:

 * 10K potentiometer: 
   * Outer leads to +5V and ground
   * wiper to LCD VO pin (pin 3)

Please take note of the indentation. This language or something similar would 
be excellent.

Why?

I have worked with several individuals new to Arduinos and these comments 
become an issue with every single person who encounters them for the first time.
Despite the first line ending with a colon it is for whatever reason difficult 
to associate the next two lines with the first, hence my request for 
indentation.
The word resistor despite being technically correct is ambiguous. I believe the 
words potentiometer, pot or variable resistor may all be suitable replacements.
Lastly, the change of "ends" to "outer leads" is more descriptive, however I do 
not take as much issue with it as the other items pointed out

Would this cause any incompatibilities with previous versions?  If so, how
can these be mitigated?

These changes are in comments only and would cause no incompatibilities. 

Original issue reported on code.google.com by thomasam...@gmail.com on 26 Jun 2013 at 6:16