Skip to content

Commit 62f66cb

Browse files
committed
resolved documentation issues and added links
1 parent e378029 commit 62f66cb

File tree

1 file changed

+10
-2
lines changed

1 file changed

+10
-2
lines changed

src/linux.rs

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,9 +36,17 @@ pub struct LinuxI2CBus {
3636
/// Linux I2C errors
3737
#[derive(Debug)]
3838
pub enum LinuxI2CError {
39-
/// Errno from a failing libc call. Sourced from `nix`.
39+
/// Errno from a failing `libc` call. Sourced from [`nix`].
4040
///
41-
/// To interpret this value `nix::Error::from_i32` should be used.
41+
/// To interpret this value [`nix::errno::from_i32`] should be used.
42+
///
43+
/// The [`Error`] implementation will return nor return a source
44+
/// for this variant. And similar will the [`Error`]
45+
/// implementation of `nix`'s error.
46+
///
47+
/// [`nix`]: https://docs.rs/nix/latest/nix/
48+
/// [`nix::errno::from_i32`]: https://docs.rs/nix/latest/nix/errno/fn.from_i32.html
49+
/// [`Error`]: https://doc.rust-lang.org/std/error/trait.Error.html
4250
Errno(i32),
4351
/// Input/output error
4452
Io(io::Error),

0 commit comments

Comments
 (0)