From 5158996149f11a7f9de0c85ae44eb72c6c1fb94f Mon Sep 17 00:00:00 2001
From: joshemb <josh@elixxir.io>
Date: Tue, 6 Sep 2022 15:36:39 -0700
Subject: [PATCH] Documentation
---
bindings/channels.go | 9 +++++++--
1 file changed, 7 insertions(+), 2 deletions(-)
diff --git a/bindings/channels.go b/bindings/channels.go
index 5ec0e502a..fcbd91225 100644
--- a/bindings/channels.go
+++ b/bindings/channels.go
@@ -84,7 +84,7 @@ func (cmt *channelManagerTracker) delete(id int) {
// Basic Channel API //
////////////////////////////////////////////////////////////////////////////////
-// ChannelsManager is a bindings-layer struct that wraps an [channels.Manager]
+// ChannelsManager is a bindings-layer struct that wraps a [channels.Manager]
// interface.
type ChannelsManager struct {
api channels.Manager
@@ -96,7 +96,12 @@ func (cm *ChannelsManager) GetID() int {
return cm.id
}
-// todo: docstring
+// NewChannelsManager constructs a ChannelsManager.
+//
+// Parameters:
+// - e2eID - The tracked e2e object ID. This can be retrieved using [E2e.GetID].
+// - udID - The tracked UD object ID. This can be retrieved using
+// [UserDiscovery.GetID].
func NewChannelsManager(e2eID, udID int) (*ChannelsManager, error) {
// Get user from singleton
user, err := e2eTrackerSingleton.get(e2eID)
--
GitLab