Feature Request #60: Add inline documentation for CanBitRate

[lordmundi]

added some small inline comments to provoke developers to make sure they adjust these lines and also explain that the suffix frequency is related to the oscillator/clock rate of the MCP2515 chip they are using.

[github-actions]

Memory usage change @ 39b968d

Board	flash	%	RAM for global variables	%
arduino:mbed_edge:edge_control	0 - 0	0.0 - 0.0	0 - 0	0.0 - 0.0
arduino:mbed_nano:nano33ble	0 - 0	0.0 - 0.0	0 - 0	0.0 - 0.0
arduino:mbed_nano:nanorp2040connect	0 - 0	0.0 - 0.0	0 - 0	0.0 - 0.0
arduino:mbed_portenta:envie_m4	0 - 0	0.0 - 0.0	0 - 0	0.0 - 0.0
arduino:mbed_portenta:envie_m7	0 - 0	0.0 - 0.0	0 - 0	0.0 - 0.0
arduino:samd:mkr1000	0 - 0	0.0 - 0.0	0 - 0	0.0 - 0.0
arduino:samd:mkrfox1200	0 - 0	0.0 - 0.0	0 - 0	0.0 - 0.0
arduino:samd:mkrgsm1400	0 - 0	0.0 - 0.0	0 - 0	0.0 - 0.0
arduino:samd:mkrnb1500	0 - 0	0.0 - 0.0	0 - 0	0.0 - 0.0
arduino:samd:mkrvidor4000	0 - 0	0.0 - 0.0	0 - 0	0.0 - 0.0
arduino:samd:mkrwan1300	0 - 0	0.0 - 0.0	0 - 0	0.0 - 0.0
arduino:samd:mkrwan1310	0 - 0	0.0 - 0.0	0 - 0	0.0 - 0.0
arduino:samd:mkrwifi1010	0 - 0	0.0 - 0.0	0 - 0	0.0 - 0.0
arduino:samd:mkrzero	0 - 0	0.0 - 0.0	0 - 0	0.0 - 0.0
esp32:esp32:esp32	0 - 0	0.0 - 0.0	0 - 0	0.0 - 0.0
rp2040:rp2040:rpipico	0 - 0	0.0 - 0.0	0 - 0	0.0 - 0.0

Click for full report table

Board	examples/MCP2515-CAN-Sniffer flash	%	examples/MCP2515-CAN-Sniffer RAM for global variables	%	examples/MCP2515-Loopback flash	%	examples/MCP2515-Loopback RAM for global variables	%
arduino:mbed_edge:edge_control	0	0.0	0	0.0	0	0.0	0	0.0
arduino:mbed_nano:nano33ble	0	0.0	0	0.0	0	0.0	0	0.0
arduino:mbed_nano:nanorp2040connect	0	0.0	0	0.0	0	0.0	0	0.0
arduino:mbed_portenta:envie_m4	0	0.0	0	0.0	0	0.0	0	0.0
arduino:mbed_portenta:envie_m7	0	0.0	0	0.0	0	0.0	0	0.0
arduino:samd:mkr1000	0	0.0	0	0.0	0	0.0	0	0.0
arduino:samd:mkrfox1200	0	0.0	0	0.0	0	0.0	0	0.0
arduino:samd:mkrgsm1400	0	0.0	0	0.0	0	0.0	0	0.0
arduino:samd:mkrnb1500	0	0.0	0	0.0	0	0.0	0	0.0
arduino:samd:mkrvidor4000	0	0.0	0	0.0	0	0.0	0	0.0
arduino:samd:mkrwan1300	0	0.0	0	0.0	0	0.0	0	0.0
arduino:samd:mkrwan1310	0	0.0	0	0.0	0	0.0	0	0.0
arduino:samd:mkrwifi1010	0	0.0	0	0.0	0	0.0	0	0.0
arduino:samd:mkrzero	0	0.0	0	0.0	0	0.0	0	0.0
esp32:esp32:esp32	0	0.0	0	0.0	0	0.0	0	0.0
rp2040:rp2040:rpipico	0	0.0	0	0.0	0	0.0	0	0.0

Click for full report CSV

Board,examples/MCP2515-CAN-Sniffer<br>flash,%,examples/MCP2515-CAN-Sniffer<br>RAM for global variables,%,examples/MCP2515-Loopback<br>flash,%,examples/MCP2515-Loopback<br>RAM for global variables,%
arduino:mbed_edge:edge_control,0,0.0,0,0.0,0,0.0,0,0.0
arduino:mbed_nano:nano33ble,0,0.0,0,0.0,0,0.0,0,0.0
arduino:mbed_nano:nanorp2040connect,0,0.0,0,0.0,0,0.0,0,0.0
arduino:mbed_portenta:envie_m4,0,0.0,0,0.0,0,0.0,0,0.0
arduino:mbed_portenta:envie_m7,0,0.0,0,0.0,0,0.0,0,0.0
arduino:samd:mkr1000,0,0.0,0,0.0,0,0.0,0,0.0
arduino:samd:mkrfox1200,0,0.0,0,0.0,0,0.0,0,0.0
arduino:samd:mkrgsm1400,0,0.0,0,0.0,0,0.0,0,0.0
arduino:samd:mkrnb1500,0,0.0,0,0.0,0,0.0,0,0.0
arduino:samd:mkrvidor4000,0,0.0,0,0.0,0,0.0,0,0.0
arduino:samd:mkrwan1300,0,0.0,0,0.0,0,0.0,0,0.0
arduino:samd:mkrwan1310,0,0.0,0,0.0,0,0.0,0,0.0
arduino:samd:mkrwifi1010,0,0.0,0,0.0,0,0.0,0,0.0
arduino:samd:mkrzero,0,0.0,0,0.0,0,0.0,0,0.0
esp32:esp32:esp32,0,0.0,0,0.0,0,0.0,0,0.0
rp2040:rp2040:rpipico,0,0.0,0,0.0,0,0.0,0,0.0

[aentinger]

This fixes #60 .

[aentinger]

Lgtm 👍