rust-embedded / embedded-hal

A Hardware Abstraction Layer (HAL) for embedded systems
Apache License 2.0
1.95k stars 197 forks source link

lib: amend documents to add periods (.), add inline hints when necessary #488

Closed luojia65 closed 1 year ago

luojia65 commented 1 year ago

In documentation style of the Rust standard library, first sentence of all modules, types, and functions documentation has a period. We follow Rust standard library style to make it easier for users to read.

Most of functions in embedded-hal{,-async,-bus,-nb} (especially type conversations, function fowarding calls) are now marked #[inline] to allow further optimizations.

Those changes affects embedded-hal, embedded-hal-async, embedded-hal-bus and embedded-hal-nb.

Note: there are multiple commits for each commit changes an amount of files of certain module. If that's not the case, please reply and I'll squash the commits.