Update fn comments

schroeder- · Nov 1, 2021 · 2f66ed4 · 2f66ed4
1 parent aa132ee
commit 2f66ed4
Showing 1 changed file with 3 additions and 1 deletion.
diff --git 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,