From 602c69ef19af62bf8d559aabba1cefb567ec2df5 Mon Sep 17 00:00:00 2001
From: askiiart <dev@askiiart.net>
Date: Mon, 2 Dec 2024 10:06:44 -0600
Subject: [PATCH] docs: improve run() docs

---
 src/lib.rs | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/src/lib.rs b/src/lib.rs
index a03a524..68f9ec8 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -12,6 +12,8 @@ use rocket;
 use crate::data::Config;
 
 /// Runs the server
+///
+/// Returns `Ok(true)` if it succeeds, otherwise returns the error from Rocket
 pub async fn run(conf: data::Config) -> Result<bool, rocket::Error> {
     match rocket::build()
         .mount(