From 085943b000f675cc93638159ede6b3bfc5fd4a10 Mon Sep 17 00:00:00 2001
From: Alejandro Cabeza Romero <alex93cabeza@gmail.com>
Date: Mon, 30 Dec 2024 13:16:15 +0100
Subject: [PATCH] State::from_settings rustdoc

---
 overwatch-rs/src/services/state.rs | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/overwatch-rs/src/services/state.rs b/overwatch-rs/src/services/state.rs
index e2901dd..687b2c2 100644
--- a/overwatch-rs/src/services/state.rs
+++ b/overwatch-rs/src/services/state.rs
@@ -20,7 +20,8 @@ pub trait ServiceState: Sized {
     type Settings;
     /// Errors that can occur during state initialization
     type Error;
-    /// Initialize a state using the provided settings
+    /// Initialize a state using the provided settings.
+    /// This is called when [StateOperator::try_load] doesn't return a state.
     fn from_settings(settings: &Self::Settings) -> Result<Self, Self::Error>;
 }