From cef7a98c4414816ea719ae58c3848d09d4367bb6 Mon Sep 17 00:00:00 2001
From: Clombrong <cromblong@egregore.fun>
Date: Tue, 10 Jun 2025 13:03:33 +0200
Subject: docs(stream): add docstring for the start function

---
 lib/stream.ml | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/lib/stream.ml b/lib/stream.ml
index 5da4aea..dc779f8 100644
--- a/lib/stream.ml
+++ b/lib/stream.ml
@@ -1,6 +1,9 @@
 open Lwt.Syntax
 
 let start domain : Portal.t Lwt.t =
+  (** [start domain] is a promise containing a Portal (stream * push) connected to the XMPP server [domain].
+
+      Currently, it doesn't handle anything except the initial [<open/>] stanza. *)
   let* stream, _push = Portal.connect domain
   in let push = function
        | None -> _push (Some Portal.stanza_close);
-- 
cgit v1.2.3