arduino / ArduinoCore-API

Hardware independent layer of the Arduino cores defining the official API
https://www.arduino.cc/reference/en/
GNU Lesser General Public License v2.1
215 stars 119 forks source link

Add documentation for CAN API to fix #221 #222

Closed jboynes closed 1 year ago

jboynes commented 1 year ago

Add documentation to the API methods, to clarify order of message transmission and define other behaviours.

jboynes commented 1 year ago

Ugh, this failed again due to the API call to upload results. I don't have permissions to redrive this action through the UI so will upload another commit to do so. Rather than a dummy I'd apprecaite any feedback on the wording so I can incorpoarate it.

codecov-commenter commented 1 year ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Comparison is base (65633ce) 95.53% compared to head (6a263a1) 95.53%.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## master #222 +/- ## ======================================= Coverage 95.53% 95.53% ======================================= Files 16 16 Lines 1075 1075 ======================================= Hits 1027 1027 Misses 48 48 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.