aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--crates/whirl_api/src/lib.rs3
1 files changed, 3 insertions, 0 deletions
diff --git a/crates/whirl_api/src/lib.rs b/crates/whirl_api/src/lib.rs
index e6660a7..882beeb 100644
--- a/crates/whirl_api/src/lib.rs
+++ b/crates/whirl_api/src/lib.rs
@@ -64,6 +64,9 @@ impl Api {
}
}
+/// Spawn and return a thread handle for the API -- which
+/// should be -- instantiated by the `whirl_api` crate.
+///
/// # Panics
/// - A panic may occur if the mpsc sender is unable to send a clone of the
/// server.