From c22f332043b27bb8b1bc56afcc4a8fb65343cfa5 Mon Sep 17 00:00:00 2001
From: Jake Taylor <jake@elixxir.io>
Date: Thu, 17 Mar 2022 11:56:23 -0500
Subject: [PATCH] comments
---
api/results.go | 7 ++++---
1 file changed, 4 insertions(+), 3 deletions(-)
diff --git a/api/results.go b/api/results.go
index 9c5d94fa1..eb0403dee 100644
--- a/api/results.go
+++ b/api/results.go
@@ -4,6 +4,7 @@
// Use of this source code is governed by a license that can be found in the //
// LICENSE file //
///////////////////////////////////////////////////////////////////////////////
+
package api
import (
@@ -18,7 +19,7 @@ import (
"gitlab.com/xx_network/primitives/id"
)
-// Enum of possible round results to pass back
+// RoundResult is the enum of possible round results to pass back
type RoundResult uint
const (
@@ -40,7 +41,7 @@ func (rr RoundResult) String() string {
}
}
-// Callback interface which reports the requested rounds.
+// RoundEventCallback interface which reports the requested rounds.
// Designed such that the caller may decide how much detail they need.
// allRoundsSucceeded:
// Returns false if any rounds in the round map were unsuccessful.
@@ -60,7 +61,7 @@ type historicalRoundsComm interface {
GetHost(hostId *id.ID) (*connect.Host, bool)
}
-// Adjudicates on the rounds requested. Checks if they are
+// GetRoundResults adjudicates on the rounds requested. Checks if they are
// older rounds or in progress rounds.
func (c *Client) GetRoundResults(roundList []id.Round, timeout time.Duration,
roundCallback RoundEventCallback) error {
--
GitLab