lib: amend documents to add periods (.), add inline hints when necessary #488
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. All functions in embedded-hal (especially type conversations, function fowarding calls) are now marked #[inline] to allow further optimizations. Signed-off-by: Zhouqi Jiang <[email protected]>
Signed-off-by: Zhouqi Jiang <[email protected]>
Signed-off-by: Zhouqi Jiang <[email protected]>
Signed-off-by: Zhouqi Jiang <[email protected]>
Signed-off-by: Zhouqi Jiang <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.