From 7dc03676059c35eaf005732d35a1db3f3a3cee1f Mon Sep 17 00:00:00 2001 From: Clombrong Date: Fri, 27 Jun 2025 09:10:03 +0200 Subject: docs(portal): update docs for header --- portal/portal.mli | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/portal/portal.mli b/portal/portal.mli index 758893e..a9810cd 100644 --- a/portal/portal.mli +++ b/portal/portal.mli @@ -16,9 +16,9 @@ type t = { since the Portal interface is supposed to be agnostic. *) val xmlns : string -(** [header domain portal] sends an initial stream header to the provided [portal] and - the XMPP server. It returns the server-assigned [id] of the stream included in the - response stream header. +(** [header domain portal] sends an initial stream header to the XMPP server [portal] + addressed to [domain]. It returns the server-assigned [id] of the stream included in + the response stream header. When [from] is specified, a from attribute is included. *) val header : ?from:string -> string -> t -> string Lwt.t -- cgit v1.2.3