diff options
Diffstat (limited to 'lib/stream.ml')
| -rw-r--r-- | lib/stream.ml | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/lib/stream.ml b/lib/stream.ml index adf852c..1363352 100644 --- a/lib/stream.ml +++ b/lib/stream.ml @@ -9,7 +9,8 @@ type auth_mechanism = | Unknown of string [@@deriving show { with_path = false }] let get (stream : (signal, async) stream) : (signal, sync) stream Lwt.t = - (** [stanza stream] is a promise containing a full stanza of the fragments of [stream].*) + (** [stanza stream] is a promise containing a full stanza of the fragments of + [stream]. *) let traverse_stanza depth fragment = let depth = match fragment with @@ -20,7 +21,8 @@ let get (stream : (signal, async) stream) : (signal, sync) stream Lwt.t = in transform traverse_stanza 0 stream |> Markup_lwt.load let start domain : Portal.t Lwt.t = - (** [start domain] is a promise containing a Portal (stream * push) connected to the XMPP server [domain]. + (** [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 |