From 50f60298456f007eea13e071c2441911321f4ace Mon Sep 17 00:00:00 2001
From: Wilfried Chauveau <wilfried.chauveau@ithinuel.me>
Date: Sat, 21 Oct 2023 19:27:07 +0100
Subject: [PATCH] Improve `Spi::new` documentation

---
 rp2040-hal/src/spi.rs | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/rp2040-hal/src/spi.rs b/rp2040-hal/src/spi.rs
index e188d1598..6c5f345ae 100644
--- a/rp2040-hal/src/spi.rs
+++ b/rp2040-hal/src/spi.rs
@@ -254,6 +254,11 @@ impl<S: State, D: SpiDevice, P: ValidSpiPinout<D>, const DS: u8> Spi<S, D, P, DS
 impl<D: SpiDevice, P: ValidSpiPinout<D>, const DS: u8> Spi<Disabled, D, P, DS> {
     /// Create new not initialized Spi bus. Initialize it with [`.init`][Self::init]
     /// or [`.init_slave`][Self::init_slave].
+    ///
+    /// Valid pin sets are in the form of `(Tx, Sck)` or `(Tx, Rx, Sck)`
+    ///
+    /// If you pins are dynamically identified (`Pin<DynPinId, _, _>`) they will first need to pass
+    /// validation using their corresponding [`ValidatedPinXX`](ValidatedPinTx).
     pub fn new(device: D, pins: P) -> Spi<Disabled, D, P, DS> {
         Spi {
             device,