Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

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

Merged
merged 5 commits into from
Aug 23, 2023
Merged

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

merged 5 commits into from
Aug 23, 2023

Commits on Aug 23, 2023

  1. e-h: amend documents to add periods (.), add inline hints when necessary 

    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]>
    @luojia65
    luojia65 committed Aug 23, 2023
    Configuration menu
    Copy the full SHA
    a0e1f49 View commit details
    Browse the repository at this point in the history

  2. e-h-async: document fixes and inline hints. 

    Signed-off-by: Zhouqi Jiang <[email protected]>
    @luojia65
    luojia65 committed Aug 23, 2023
    Configuration menu
    Copy the full SHA
    41a61cb View commit details
    Browse the repository at this point in the history

  3. e-h-bus: document fixes and inline hints. 

    Signed-off-by: Zhouqi Jiang <[email protected]>
    @luojia65
    luojia65 committed Aug 23, 2023
    Configuration menu
    Copy the full SHA
    d81f7b8 View commit details
    Browse the repository at this point in the history

  4. e-h-nb: inline hints, document fixes. 

    Signed-off-by: Zhouqi Jiang <[email protected]>
    @luojia65
    luojia65 committed Aug 23, 2023
    Configuration menu
    Copy the full SHA
    8296af2 View commit details
    Browse the repository at this point in the history

  5. e-h, e-h-async, e-h-bus, e-h-nb: add changelog entries 

    Signed-off-by: Zhouqi Jiang <[email protected]>
    @luojia65
    luojia65 committed Aug 23, 2023
    Configuration menu
    Copy the full SHA
    d2f099e View commit details
    Browse the repository at this point in the history