Skip to content

Commit

Permalink
Update src/watchdog.rs
Browse files Browse the repository at this point in the history
Co-authored-by: Diego Barrios Romero <eldruin@gmail.com>

Update this change to changelog; thanks @eldruin

Update CHANGELOG.md

Co-authored-by: Diego Barrios Romero <eldruin@gmail.com>

Update document
  • Loading branch information
luojia65 committed Jul 15, 2020
1 parent 6b20899 commit 538583c
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 3 deletions.
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,10 @@ and this project adheres to [Semantic Versioning](http://semver.org/).

## [Unreleased]

### Changed

- The watchdog API now uses move semantics. See [PR](https://github.com/rust-embedded/embedded-hal/pull/222).

## [v1.0.0-alpha.1] - 2020-06-16

*** This is an alpha release with breaking changes (sorry) ***
Expand Down
6 changes: 3 additions & 3 deletions src/watchdog.rs
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
//! Traits for interactions with a processors watchdog timer.
/// Feeds an existing watchdog to ensure the processor isn't reset. Sometimes
/// the "feeding" operation is commonly referred to as "refreshing".
/// the "feeding" operation is also referred to as "refreshing".
pub trait Watchdog {
/// An enumeration of `Watchdog` errors.
///
Expand Down Expand Up @@ -54,7 +54,7 @@ pub trait Disable {

/// Disables the watchdog.
///
/// This stops the watchdog and returns the `Enable` trait so that
/// it can be started again.
/// This stops the watchdog and returns an instance implementing the
/// `Enable` trait so that it can be started again.
fn try_disable(self) -> Result<Self::Target, Self::Error>;
}

0 comments on commit 538583c

Please sign in to comment.