comments cleanup and debounce comments

[mattvenn]

The only code change I made was this:

changes = delta & ~debouncer->db0 & ~debouncer->db1;

Instead of:

changes = ~(~delta | (debouncer->db0) | (debouncer->db1));

Which are equivalent, but the first makes more intuitive sense: only change when delta is true and the counter is wrapped back to 0.

[obra]

FWIW, I'm holding off on merging anything until the Keyboardio Model 01's firmware is tagged. Thank you!

…

On Fri, Jun 16, 2017 at 12:56:33AM -0700, matt venn wrote: The only code change I made was this: changes = delta & ~debouncer->db0 & ~debouncer->db1; Instead of: changes = ~(~delta | (debouncer->db0) | (debouncer->db1)); Which are equivalent, but the first makes more intuitive sense: only change when delta is true and the counter is wrapped back to 0. -------------------------------------------------------------------------- You can view, comment on, or merge this pull request online at:   [1]#1 Commit Summary * comments * explanatory comments and imroved readability of code File Changes * M [2]firmware/debounce.h (37) * M [3]firmware/keyscanner.c (19) Patch Links: * [4]https://github.com/keyboardio/avr_keyscanner/pull/1.patch * [5]https://github.com/keyboardio/avr_keyscanner/pull/1.diff � You are receiving this because you are subscribed to this thread. Reply to this email directly, [6]view it on GitHub, or [7]mute the thread. Reverse link: [8]unknown References Visible links 1. #1 2. https://github.com/keyboardio/avr_keyscanner/pull/1/files#diff-0 3. https://github.com/keyboardio/avr_keyscanner/pull/1/files#diff-1 4. https://github.com/keyboardio/avr_keyscanner/pull/1.patch 5. https://github.com/keyboardio/avr_keyscanner/pull/1.diff 6. #1 7. https://github.com/notifications/unsubscribe-auth/AACxaP7Wg6rGjYFjq6Ox6vnNv9ZPTT45ks5sEjUxgaJpZM4N8JHy 8. #1

--

[algernon]

I'm not sure how I could test this on the hardware, but the changes look good, and the new comments help a lot in understanding the code.

As the Model01 firmware has been tagged, I believe this could go in now.

[obra]

@algernon - Can you split this out to two separate things: comments and code refactoring? The comments should be good to go in immediately. The code refactoring, we'd want to test more carefully.