From d2f4a9bf8df8de9f51b29659b464b4509af47dc6 Mon Sep 17 00:00:00 2001 From: Dario Nieuwenhuis Date: Tue, 19 Jul 2022 07:57:39 +0200 Subject: embassy-embedded-hal: docs --- embassy-embedded-hal/src/adapter.rs | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) (limited to 'embassy-embedded-hal/src/adapter.rs') diff --git a/embassy-embedded-hal/src/adapter.rs b/embassy-embedded-hal/src/adapter.rs index 7d25d89fc..1c43f015f 100644 --- a/embassy-embedded-hal/src/adapter.rs +++ b/embassy-embedded-hal/src/adapter.rs @@ -1,9 +1,12 @@ +//! Adapters between embedded-hal traits. + use core::future::Future; use embedded_hal_02::{blocking, serial}; -/// BlockingAsync is a wrapper that implements async traits using blocking peripherals. This allows -/// driver writers to depend on the async traits while still supporting embedded-hal peripheral implementations. +/// Wrapper that implements async traits using blocking implementations. +/// +/// This allows driver writers to depend on the async traits while still supporting embedded-hal peripheral implementations. /// /// BlockingAsync will implement any async trait that maps to embedded-hal traits implemented for the wrapped driver. /// -- cgit