diff options
| author | Clombrong <cromblong@egregore.fun> | 2025-06-27 09:10:03 +0200 |
|---|---|---|
| committer | Clombrong <cromblong@egregore.fun> | 2025-06-27 09:54:44 +0200 |
| commit | 7dc03676059c35eaf005732d35a1db3f3a3cee1f (patch) | |
| tree | f0d0fae0f6b4ee6e03485c905bdd21af58cb4d8f | |
| parent | a808e8a486ba3e08bc62cc77c7a0724fb8173b81 (diff) | |
docs(portal): update docs for header
| -rw-r--r-- | portal/portal.mli | 6 |
1 files 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 |