Skip to content

Commit 8cd89e2

Browse files
authored
Merge pull request #497 from nyurik/spelling
A few minor spelling/grammar fixes
2 parents 0f7bf70 + f3095b3 commit 8cd89e2

File tree

5 files changed

+10
-10
lines changed

5 files changed

+10
-10
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ This project is developed and maintained by the [HAL team](https://github.com/ru
66

77
## Scope
88

9-
`embedded-hal` serves as a foundation for building an ecosystem of platform agnostic drivers.
9+
`embedded-hal` serves as a foundation for building an ecosystem of platform-agnostic drivers.
1010
(driver meaning library crates that let a target platform interface an external device like a digital
1111
sensor or a wireless transceiver).
1212

embedded-can/src/lib.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ pub trait Frame: Sized {
2222
/// This will return `None` if the data length code (DLC) is not valid.
2323
fn new_remote(id: impl Into<Id>, dlc: usize) -> Option<Self>;
2424

25-
/// Returns true if this frame is a extended frame.
25+
/// Returns true if this frame is an extended frame.
2626
fn is_extended(&self) -> bool;
2727

2828
/// Returns true if this frame is a standard frame.

embedded-hal/CHANGELOG.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
9393
- Fixed blanket impl of `DelayUs` not covering the `delay_ms` method.
9494

9595
### Changed
96-
- `spi`: traits now enforce all impls on the same struct (eg `Transfer` and `Write`) have the same `Error` type.
96+
- `spi`: traits now enforce all impls on the same struct (e.g. `Transfer` and `Write`) have the same `Error` type.
9797
- `digital`: traits now enforce all impls on the same struct have the same `Error` type.
9898
- `serial`: traits now enforce all impls on the same struct have the same `Error` type.
9999
- `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/).
150150
### Changed
151151
- Swap PWM channel arguments to references
152152
- All trait methods have been renamed to remove the `try_` prefix (i.e. `try_send` -> `send`) for consistency.
153-
- 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`.
153+
- 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`.
154154
- 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.
155155
- Re-export `nb::{block!, Error, Result}` to avoid version mismatches. These should be used instead of
156156
importing the `nb` crate directly in dependent crates.
@@ -281,7 +281,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
281281

282282
### Changed
283283

284-
- Re-export most / unchanged traits from embedded-hal v0.2.x to allow inter-operation between HAL
284+
- Re-export most / unchanged traits from embedded-hal v0.2.x to allow interoperation between HAL
285285
implementations and drivers that are using different minor versions.
286286

287287
## [v0.1.2] - 2018-02-14

embedded-hal/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ Additionally, more domain-specific traits are available in separate crates:
3535

3636
The HAL
3737

38-
- Must *erase* device specific details. Neither register, register blocks or magic values should
38+
- Must *erase* device specific details. Neither register, register blocks, nor magic values should
3939
appear in the API.
4040

4141
- 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
5050
want higher level abstraction should *prefer to use this HAL* rather than *re-implement*
5151
register manipulation code.
5252

53-
- Serve as a foundation for building an ecosystem of platform agnostic drivers. Here driver
53+
- Serve as a foundation for building an ecosystem of platform-agnostic drivers. Here driver
5454
means a library crate that lets a target platform interface an external device like a digital
5555
sensor or a wireless transceiver. The advantage of this system is that by writing the driver as
5656
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*.
7070

7171
## Platform agnostic drivers
7272

73-
You can find platform agnostic drivers built on top of `embedded-hal` on crates.io by [searching
73+
You can find platform-agnostic drivers built on top of `embedded-hal` on crates.io by [searching
7474
for the *embedded-hal* keyword](https://crates.io/keywords/embedded-hal).
7575

76-
If you are writing a platform agnostic driver yourself you are highly encouraged to [add the
76+
If you are writing a platform-agnostic driver yourself you are highly encouraged to [add the
7777
embedded-hal keyword](https://doc.rust-lang.org/cargo/reference/manifest.html#package-metadata)
7878
to your crate before publishing it!
7979

embedded-hal/src/i2c.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@
3535
//!
3636
//! The [`embedded-hal-bus`](https://docs.rs/embedded-hal-bus) crate provides several
3737
//! implementations for sharing I2C buses. You can use them to take an exclusive instance
38-
//! you've received from a HAL and "split" it into mulitple shared ones, to instantiate
38+
//! you've received from a HAL and "split" it into multiple shared ones, to instantiate
3939
//! several drivers on the same bus.
4040
//!
4141
//! # For driver authors

0 commit comments

Comments
 (0)