From d5aec5cdd1fde9ee0bcce3bf247c9840859503b6 Mon Sep 17 00:00:00 2001
From: David Stainton <dstainton@elixxir.io>
Date: Thu, 25 Aug 2022 12:35:41 -0400
Subject: [PATCH] ud: add docstring to StartChannelNameService

---
 ud/channelIDTracking.go | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/ud/channelIDTracking.go b/ud/channelIDTracking.go
index f6becde3b..8f9f4f918 100644
--- a/ud/channelIDTracking.go
+++ b/ud/channelIDTracking.go
@@ -303,6 +303,10 @@ func (c *clientIDTracker) requestChannelLease() (int64, []byte, error) {
 	return resp.Lease, resp.UDLeaseEd25519Signature, err
 }
 
+// StartChannelNameService creates a new clientIDTracker
+// and returns a reference to it's type as the NameService interface.
+// However it's scheduler thread isn't started until it's Start
+// method is called.
 func (m *Manager) StartChannelNameService() NameService {
 	udPubKeyBytes := m.user.GetCmix().GetInstance().GetPartialNdf().Get().UDB.DhPubKey
 	var service NameService
-- 
GitLab