From 2f66ed4c284afaac5b05b68863de86102b4b8b1e Mon Sep 17 00:00:00 2001
From: Adam Lock <locka99@gmail.com>
Date: Mon, 1 Nov 2021 12:55:19 +0000
Subject: [PATCH] Update fn comments

---
 server/src/server.rs | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/server/src/server.rs b/server/src/server.rs
index 46927ee72..1c108366a 100644
--- a/server/src/server.rs
+++ b/server/src/server.rs
@@ -241,7 +241,9 @@ impl Server {
     }
 
     /// Allow the server to be run on a caller supplied runtime. If block is set, the task
-    /// runs to completion, otherwise, the task runs and a join handle is returned by this fn.
+    /// runs to completion (abort or by error), otherwise, the task is spawned and a join handle is
+    /// returned by the function. Spawning might be suitable if the runtime is being used for other
+    /// async tasks.
     pub fn run_server_on_runtime<F>(
         runtime: tokio::runtime::Runtime,
         server_task: F,