Skip to content
This repository has been archived by the owner on Mar 19, 2024. It is now read-only.

fixup: doc: minor documentation fixes #9

Merged
merged 1 commit into from
Jan 16, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions src/gpio/error.rs
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ use core::fmt;
use embedded_hal::digital::Error as GpioError;
pub use embedded_hal::digital::ErrorKind;

/// Convenience [`Result`](core::result::Result) alias for JH71xx GPIO module.
pub type Result<T> = core::result::Result<T, Error>;

/// GPIO errors.
Expand Down
2 changes: 1 addition & 1 deletion src/i2c/error.rs
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ use core::convert::Infallible;

use embedded_hal::i2c::{Error as I2cError, ErrorKind, NoAcknowledgeSource};

/// Convenience alias for the I2C `Result` type.
/// Convenience [`Result`](core::result::Result) alias for JH71xx I2C module.
pub type Result<T> = core::result::Result<T, Error>;

/// I2C Error types
Expand Down
2 changes: 1 addition & 1 deletion src/pwm/error.rs
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
use embedded_hal::pwm::{Error as PwmError, ErrorKind};

/// Convenience alias for the PWM module [`Result`](core::result::Result) type.
/// Convenience [`Result`](core::result::Result) alias for JH71xx PWM module.
pub type Result<T> = core::result::Result<T, Error>;

/// Represents the PWM module error type.
Expand Down
2 changes: 1 addition & 1 deletion src/spi/error.rs
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ use embedded_hal::spi::{Error as SpiError, ErrorKind};

use super::DataSize;

/// Convenience [`Result`](core::result::Result] alias for JH71xx SPI module.
/// Convenience [`Result`](core::result::Result) alias for JH71xx SPI module.
pub type Result<T> = core::result::Result<T, Error>;

/// SPI error type for JH71xx SoCs.
Expand Down
2 changes: 1 addition & 1 deletion src/uart/error.rs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
/// Convenience alias for the UART result type.
/// Convenience [`Result`](core::result::Result) alias for JH71xx UART module.
pub type Result<T> = core::result::Result<T, Error>;

/// Error type for the UART peripheral
Expand Down
Loading