Clarify and add details to documents #1383
Conversation
Thoughts: - changing the name in display to "Calibrate Tip Offset" (currently shows Calibrate temperature) might be more clear, and then people will not get nervous and think the number displayed means temperature? since it is just a number, i.e., 765, and does not say "765 offset" I suggest changing to either "number Offset" or changing menu name to "Calibrate Tip Offset" . when people incorrectly beleive the high number is temperature, since it says "calibrate temperature?" then it leads to unwarranted concern that the pinecil or IronOS is broken.
clarify language, add punctuation.
There was a problem hiding this comment.
My only question is for the Temperature.md file.
I'm not sure what this sentence means or if there is simply a Typo of the word "bad"
" it will regulate to within around +-3 °C but not indicate you are outside of this bad until you exceed +-5 °C"
is this meant to say something like...
"it will regulate to within around +/- 3 °C but not indicated you are outside of the margin of error until you exceed +/-5 °C. This gives the illusion that it's holding the temperature perfectly when in actuality it's moving around as well."
|
Yeah thats a typo of "band". But yes your replacement works :) |
|
Co-authored-by: discip <[email protected]>
In which troubleshooting conditions/symptoms would: (1) Re-calibrating tip offset temperature be appropriate? (2) Re-Calibrating Input voltage be appropriate? I think these 2 internal tests would be helpful sections for Troubleshooting, but not sure of all details to write-up.
Add details to several documents and clarify other sections.
Added release information to the History document.