Add a note about the macro in the transaction method docs

rust-embedded · Sep 20, 2022 · 5842633 · 5842633
1 parent 6c9f380
commit 5842633
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/embedded-hal-async/src/spi.rs b/embedded-hal-async/src/spi.rs
@@ -160,6 +160,10 @@ pub unsafe trait SpiDevice: ErrorType {
 
     /// Perform a transaction against the device.
     ///
+    /// **NOTE:**
+    /// It is not recommended to use this method directly, because it requires `unsafe` code to dereference the raw pointer.
+    /// Instead, the [`transaction!`] macro should be used, which handles this safely inside the macro.
+    /// 
     /// - Locks the bus
     /// - Asserts the CS (Chip Select) pin.
     /// - Calls `f` with an exclusive reference to the bus, which can then be used to do transfers against the device.