doc fixes

Cargo.toml

@@ -8,20 +8,20 @@ edition = "2018"
 version = "0.11.0"
 
 [package.metadata.docs.rs]
-all-features = true
+features = [ "std", "nonblocking", "mock", "helpers" ]
 
 [features]
 std = [ ]
 nonblocking = [ ]
 mock = [ "embedded-hal-mock" ]
-helpers = [ "structopt", "humantime", "std", "pcap-file", "libc", "byteorder", "rolling-stats", "log" ]
-default = []
+helpers = [ "structopt", "humantime", "std", "pcap-file", "libc", "byteorder", "rolling-stats" ]
+default = [ ]
 
 [dependencies]
 embedded-hal = "1.0.0-alpha.7"
 nb = "1.0.0"
 
-log = { version = "0.4.14", optional = true, default_features = false }
+log = { version = "0.4.14", default_features = false }
 defmt = { version = "0.3.0", optional = true }
 
 humantime = { version = "2.0.1", optional = true }

src/blocking.rs

@@ -3,15 +3,15 @@
 //! These implementations use the radio's DelayUs implementation to
 //! poll on completion of operations.
 //!
-//! ## https://github.com/ryankurte/rust-radio
-//! ## Copyright 2020 Ryan Kurte
+//! ## <https://github.com/rust-iot/radio-hal>
+//! ## Copyright 2020-2022 Ryan Kurte
 
 use core::fmt::Debug;
 use core::time::Duration;
 
 use embedded_hal::delay::blocking::DelayUs;
 
-#[cfg(feature = "log")]
+#[cfg(not(feature = "defmt"))]
 use log::debug;
 
 #[cfg(feature = "defmt")]

src/helpers.rs

@@ -1,7 +1,7 @@
 //! Provides common helpers for implementing radio utilities
 //!
-//! ## https://github.com/ryankurte/rust-radio
-//! ## Copyright 2020 Ryan Kurte
+//! ## <https://github.com/rust-iot/radio-hal>
+//! ## Copyright 2020-2022 Ryan Kurte
 
 use std::ffi::CString;
 use std::fs::{File, OpenOptions};
@@ -11,7 +11,7 @@ use std::time::SystemTime;
 
 use libc::{self};
 
-#[cfg(feature = "log")]
+#[cfg(not(feature = "defmt"))]
 use log::{debug, info};
 
 #[cfg(feature = "defmt")]
@@ -235,7 +235,10 @@ where
 
  match std::str::from_utf8(&buff[0..n as usize]) {
  Ok(s) => info!("Received: '{}' info: {:?}", s, i),
- Err(_) => info!("Received: '{:x?}' info: {:?}", &buff[0..n as usize], i),
+ #[cfg(not(feature = "defmt"))]
+ Err(_) => info!("Received: '{:02x?}' info: {:?}", &buff[0..n as usize], i),
+ #[cfg(feature = "defmt")]
+ Err(_) => info!("Received: '{:?}' info: {:?}", &buff[0..n as usize], i),
  }
 
  if let Some(p) = &mut pcap_writer {
@@ -356,7 +359,10 @@ where
  // Parse out string if possible, otherwise print hex
  match std::str::from_utf8(&buff[0..n as usize]) {
  Ok(s) => info!("Received: '{}' info: {:?}", s, i),
+ #[cfg(not(feature = "defmt"))]
  Err(_) => info!("Received: '{:02x?}' info: {:?}", &buff[0..n as usize], i),
+ #[cfg(feature = "defmt")]
+ Err(_) => info!("Received: '{:?}' info: {:?}", &buff[0..n as usize], i),
  }
 
  // Append info if provided

src/lib.rs

@@ -3,8 +3,8 @@
 //! This package defines traits for packet radio devices, as well as blocking and async
 //! implementations using these traits, and a mock device to support application level testing.
 //!
-//! ## https://github.com/ryankurte/rust-radio
-//! ## Copyright 2020 Ryan Kurte
+//! ## <https://github.com/rust-iot/radio-hal>
+//! ## Copyright 2020-2022 Ryan Kurte
 
 // Set `no_std` where `std` feature is disabled
 #![cfg_attr(not(feature = "std"), no_std)]

src/mock.rs

@@ -3,8 +3,8 @@
 //! This provides a generic and specific mock implementation of the radio traits
 //! to support network and application level testing.
 //!
-//! ## https://github.com/ryankurte/rust-radio
-//! ## Copyright 2020 Ryan Kurte
+//! ## <https://github.com/rust-iot/radio-hal>
+//! ## Copyright 2020-2022 Ryan Kurte
 
 extern crate std;
 use std::convert::Infallible;

src/nonblocking.rs

@@ -1,8 +1,8 @@
 //! Non-blocking (async/await) APIs on top of the base radio traits
 //! Note that this _requires_ use of unstable `feature(generic_associated_types)`
 //!
-//! ## https://github.com/ryankurte/rust-radio
-//! ## Copyright 2020 Ryan Kurte
+//! ## <https://github.com/rust-iot/radio-hal>
+//! ## Copyright 2020-2022 Ryan Kurte
 
 use core::fmt::Debug;
 use core::future::Future;