Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Confusing documentation in RHGenericDriver.h #64

Open
douglasheld2 opened this issue Jan 11, 2022 · 0 comments
Open

Confusing documentation in RHGenericDriver.h #64

douglasheld2 opened this issue Jan 11, 2022 · 0 comments

Comments

@douglasheld2
Copy link

douglasheld2 commented Jan 11, 2022

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:

  1. members that start with _rx should be described as messages received (i.e. change doc for _txGood)
  2. members that start with _tx should be described as messages transmitted (i.e. change doc for _rxGood)
  3. "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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant