diff --git a/README.md b/README.md index 02cee6050..3d86509eb 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ This project is developed and maintained by the [HAL team](https://github.com/ru ## Scope -`embedded-hal` serves as a foundation for building an ecosystem of platform agnostic drivers. +`embedded-hal` serves as a foundation for building an ecosystem of platform-agnostic drivers. (driver meaning library crates that let a target platform interface an external device like a digital sensor or a wireless transceiver). diff --git a/embedded-can/src/lib.rs b/embedded-can/src/lib.rs index db80c455b..2de2b6ebc 100644 --- a/embedded-can/src/lib.rs +++ b/embedded-can/src/lib.rs @@ -22,7 +22,7 @@ pub trait Frame: Sized { /// This will return `None` if the data length code (DLC) is not valid. fn new_remote(id: impl Into, dlc: usize) -> Option; - /// Returns true if this frame is a extended frame. + /// Returns true if this frame is an extended frame. fn is_extended(&self) -> bool; /// Returns true if this frame is a standard frame. diff --git a/embedded-hal/CHANGELOG.md b/embedded-hal/CHANGELOG.md index 8c6109d6c..019080d5c 100644 --- a/embedded-hal/CHANGELOG.md +++ b/embedded-hal/CHANGELOG.md @@ -93,7 +93,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/). - Fixed blanket impl of `DelayUs` not covering the `delay_ms` method. ### Changed -- `spi`: traits now enforce all impls on the same struct (eg `Transfer` and `Write`) have the same `Error` type. +- `spi`: traits now enforce all impls on the same struct (e.g. `Transfer` and `Write`) have the same `Error` type. - `digital`: traits now enforce all impls on the same struct have the same `Error` type. - `serial`: traits now enforce all impls on the same struct have the same `Error` type. - `i2c`: traits now enforce all impls on the same struct have the same `Error` type. @@ -150,7 +150,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/). ### Changed - Swap PWM channel arguments to references - All trait methods have been renamed to remove the `try_` prefix (i.e. `try_send` -> `send`) for consistency. -- Moved all traits into two sub modules for each feature depending on the execution model: `blocking` and `nb` (non-blocking). For example, the spi traits can now be found under `embedded_hal::spi::blocking` or `embedded_hal::spi::nb`. +- Moved all traits into two submodules for each feature depending on the execution model: `blocking` and `nb` (non-blocking). For example, the spi traits can now be found under `embedded_hal::spi::blocking` or `embedded_hal::spi::nb`. - Execution-model-independent definitions have been moved into the feature module. For example, SPI `Phase` is now defined in `embedded_hal::spi::Phase`. For convenience, these definitions are reexported in both of its blocking and non-blocking submodules. - Re-export `nb::{block!, Error, Result}` to avoid version mismatches. These should be used instead of importing the `nb` crate directly in dependent crates. @@ -281,7 +281,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/). ### Changed -- Re-export most / unchanged traits from embedded-hal v0.2.x to allow inter-operation between HAL +- Re-export most / unchanged traits from embedded-hal v0.2.x to allow interoperation between HAL implementations and drivers that are using different minor versions. ## [v0.1.2] - 2018-02-14 diff --git a/embedded-hal/README.md b/embedded-hal/README.md index 193c63b3a..391599ec5 100644 --- a/embedded-hal/README.md +++ b/embedded-hal/README.md @@ -35,7 +35,7 @@ Additionally, more domain-specific traits are available in separate crates: The HAL -- Must *erase* device specific details. Neither register, register blocks or magic values should +- Must *erase* device specific details. Neither register, register blocks, nor magic values should appear in the API. - Must be generic *within* a device and *across* devices. The API to use a serial interface must @@ -50,7 +50,7 @@ in blocking mode, with the `futures` model, with an async/await model or with a want higher level abstraction should *prefer to use this HAL* rather than *re-implement* register manipulation code. -- Serve as a foundation for building an ecosystem of platform agnostic drivers. Here driver +- Serve as a foundation for building an ecosystem of platform-agnostic drivers. Here driver means a library crate that lets a target platform interface an external device like a digital sensor or a wireless transceiver. The advantage of this system is that by writing the driver as a generic library on top of `embedded-hal` driver authors can support any number of target @@ -70,10 +70,10 @@ interface are not using the same pins". The HAL will focus on *doing I/O*. ## Platform agnostic drivers -You can find platform agnostic drivers built on top of `embedded-hal` on crates.io by [searching +You can find platform-agnostic drivers built on top of `embedded-hal` on crates.io by [searching for the *embedded-hal* keyword](https://crates.io/keywords/embedded-hal). -If you are writing a platform agnostic driver yourself you are highly encouraged to [add the +If you are writing a platform-agnostic driver yourself you are highly encouraged to [add the embedded-hal keyword](https://doc.rust-lang.org/cargo/reference/manifest.html#package-metadata) to your crate before publishing it! diff --git a/embedded-hal/src/i2c.rs b/embedded-hal/src/i2c.rs index e42b16ebc..8f4848a28 100644 --- a/embedded-hal/src/i2c.rs +++ b/embedded-hal/src/i2c.rs @@ -35,7 +35,7 @@ //! //! The [`embedded-hal-bus`](https://docs.rs/embedded-hal-bus) crate provides several //! implementations for sharing I2C buses. You can use them to take an exclusive instance -//! you've received from a HAL and "split" it into mulitple shared ones, to instantiate +//! you've received from a HAL and "split" it into multiple shared ones, to instantiate //! several drivers on the same bus. //! //! # For driver authors