Skip to content

Commit d90b59b

Browse files
authored
Merge pull request #563 from Dirbaio/docs-fixes
Misc doc fixes.
2 parents f8c79fe + ebc756e commit d90b59b

File tree

4 files changed

+10
-4
lines changed

4 files changed

+10
-4
lines changed

docs/migrating-from-0.2-to-1.0.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -340,7 +340,7 @@ have mutable state or access exclusive resources.
340340
for implementations.
341341

342342
For ease of use, you might want to provide inherent methods that take `&self` if the hardware permits it. In this case,
343-
you might need to do `&*self` to call them from the trait methods. Otherwise Rust will resolve the
343+
you might need to do `*self` to call them from the trait methods. Otherwise Rust will resolve the
344344
method call to the trait method, causing infinite recursion.
345345

346346
```rust
@@ -358,12 +358,12 @@ impl HalPin {
358358

359359
impl InputPin for HalPin {
360360
fn is_high(&mut self) -> Result<bool, Self::Error> {
361-
// Needs `&*self` so that the inherent `is_high` is picked.
362-
Ok((&*self).is_high())
361+
// Needs `*self` so that the inherent `is_high` is picked.
362+
Ok((*self).is_high())
363363
}
364364

365365
fn is_low(&mut self) -> Result<bool, Self::Error> {
366-
Ok((&*self).is_low())
366+
Ok((*self).is_low())
367367
}
368368
}
369369
```

embedded-hal-async/CHANGELOG.md

+2
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ No unreleased changes yet.
1111

1212
## [v1.0.0] - 2023-12-28
1313

14+
Check out the [announcement blog post](https://blog.rust-embedded.org/embedded-hal-v1/) and the [migration guide](../docs/migrating-from-0.2-to-1.0.md) for help with migrating from v0.2 to v1.0.
15+
1416
- Updated `embedded-hal` to version `1.0.0`.
1517

1618
## [v1.0.0-rc.3] - 2023-12-14

embedded-hal-nb/CHANGELOG.md

+2
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ No unreleased changes
1111

1212
## [v1.0.0] - 2023-12-28
1313

14+
Check out the [announcement blog post](https://blog.rust-embedded.org/embedded-hal-v1/) and the [migration guide](../docs/migrating-from-0.2-to-1.0.md) for help with migrating from v0.2 to v1.0.
15+
1416
- Updated `embedded-hal` to version `1.0.0`.
1517

1618
## [v1.0.0-rc.3] - 2023-12-14

embedded-hal/CHANGELOG.md

+2
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ No unreleased changes yet.
1111

1212
## [v1.0.0] - 2023-12-28
1313

14+
Check out the [announcement blog post](https://blog.rust-embedded.org/embedded-hal-v1/) and the [migration guide](../docs/migrating-from-0.2-to-1.0.md) for help with migrating from v0.2 to v1.0.
15+
1416
- gpio: remove `ToggleableOutputPin`, move `toggle()` to `StatefulOutputPin`.
1517

1618
## [v1.0.0-rc.3] - 2023-12-14

0 commit comments

Comments
 (0)