diff options
| author | Clombrong <cromblong@egregore.fun> | 2025-08-15 00:21:00 +0200 |
|---|---|---|
| committer | Clombrong <cromblong@egregore.fun> | 2025-08-15 00:21:00 +0200 |
| commit | 8d6b3cba4fa9538c42d3126aa02962b0cd7371ca (patch) | |
| tree | da8f002b13ddf0ed84b89395434d9f71dddbb448 | |
| parent | 383928958376423d8588888386b52e4a8b30d8da (diff) | |
docs(session): update doc according to session type
| -rw-r--r-- | lib/session.ml | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/lib/session.ml b/lib/session.ml index b1eb2c3..7a69d37 100644 --- a/lib/session.ml +++ b/lib/session.ml @@ -14,13 +14,15 @@ type state = (* TCP/WebSocket connected, not connected in XMPP-land *) | Connected of Portal.t * step +(** An XMPP session. This type contains a signal representing the state of an XMPP + connection, and its update function. *) type t = { state : state signal; update : state -> unit; } -(** [create domain config] is a promise containing a signal representing the portal - connected to the XMPP server located at [domain], and all its supported features. +(** [create domain config] is a promise containing a session representing the portal + connected to the XMPP server located at [domain]. When calling the function, the portal will try to connect to the provided domain. |