Confusing documentation in RHGenericDriver.h
douglasheld2 opened this issue · 0 comments
douglasheld2 commented
I'm pretty sure there is a copy/paste typo or two in this documentation at the bottom of RHGenericDriver.h:
:
/// Count of the number of bad messages (eg bad checksum etc) received
volatile uint16_t _rxBad;
/// Count of the number of successfully transmitted messaged
volatile uint16_t _rxGood;
/// Count of the number of bad messages (correct checksum etc) received
volatile uint16_t _txGood;
Proposed change:
- members that start with _rx should be described as messages received (i.e. change doc for _txGood)
- members that start with _tx should be described as messages transmitted (i.e. change doc for _rxGood)
- "good" should be associated with "correct", (i.e. change the doc for _txGood)
Or else, add enough explanatory text to explain why a correct checksum might be a bad packet, and be labeled "Good", etc.