From 04e13e623b3aafdc11218a5241e0cd328ef1a47a Mon Sep 17 00:00:00 2001
From: Jake Taylor <jake@elixxir.io>
Date: Thu, 4 Aug 2022 11:48:38 -0500
Subject: [PATCH] update docstring for connect.StartServer
---
connect/connect.go | 5 ++++-
1 file changed, 4 insertions(+), 1 deletion(-)
diff --git a/connect/connect.go b/connect/connect.go
index b221e5853..f998281a2 100644
--- a/connect/connect.go
+++ b/connect/connect.go
@@ -125,8 +125,11 @@ func Connect(recipient contact.Contact, user *xxdk.E2e,
//
// It is recommended that this be called before StartNetworkFollower to ensure
// no requests are missed.
-// This call does an xxDK.ephemeralLogin under the hood and the connection
+//
+// This calls xxdk.LoginEphemeral under the hood and the connection
// server must be the only listener on auth.
+//
+// The given Callback needs to handle receiving a nil Connection.
func StartServer(identity xxdk.ReceptionIdentity, connectionCallback Callback,
net *xxdk.Cmix, params xxdk.E2EParams, clParams ConnectionListParams) (*ConnectionServer, error) {
--
GitLab