From 6ff773d5edf0f6f5ffa4c40d5ae3e8ffa6892584 Mon Sep 17 00:00:00 2001
From: Lachezar Lechev <elpiel93@gmail.com>
Date: Wed, 12 Jul 2023 17:40:47 +0300
Subject: [PATCH] docs: document initialize_manual default gateway

Signed-off-by: Lachezar Lechev <elpiel93@gmail.com>
---
 src/uninitialized_device.rs | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/src/uninitialized_device.rs b/src/uninitialized_device.rs
index ae230a3..9624f62 100644
--- a/src/uninitialized_device.rs
+++ b/src/uninitialized_device.rs
@@ -58,6 +58,10 @@ impl<SpiBus: Bus> UninitializedDevice<SpiBus> {
         self.initialize_with_host(host, mode_options)
     }
 
+
+    /// The gateway overrides the passed `ip` ([`Ip4Addr`]) to end with `.1`.
+    ///
+    /// E.g. `let ip = "192.168.0.201".parse::<Ip4Addr>()` will become a device with a gateway `192.168.0.1`.
     pub fn initialize_manual(
         self,
         mac: MacAddress,