From d5bd9b11ce64251e2b4610ee4a9e3d5293eedb28 Mon Sep 17 00:00:00 2001
From: joshemb <josh@elixxir.io>
Date: Wed, 10 Aug 2022 10:22:47 -0700
Subject: [PATCH] Clean up documentation
---
bindings/dummy.go | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)
diff --git a/bindings/dummy.go b/bindings/dummy.go
index 77b9aafe7..045b950b9 100644
--- a/bindings/dummy.go
+++ b/bindings/dummy.go
@@ -32,9 +32,9 @@ type DummyTraffic struct {
// each sending cycle.
// - avgSendDeltaMS - the average duration, in milliseconds, to wait
// between sends.
-// - randomRangeMS - the upper bound of the interval between sending cycles.
-// Sends occur every avgSendDeltaMS +/- a random duration with an
-// upper bound of randomRangeMS
+// - randomRangeMS - the upper bound of the interval between sending cycles,
+// in milliseconds. Sends occur every avgSendDeltaMS +/- a random duration
+// with an upper bound of randomRangeMS.
func NewDummyTrafficManager(e2eID, maxNumMessages, avgSendDeltaMS,
randomRangeMS int) (*DummyTraffic, error) {
@@ -62,7 +62,7 @@ func NewDummyTrafficManager(e2eID, maxNumMessages, avgSendDeltaMS,
//
// Params:
// - boolean - True: Sending thread is sending dummy messages.
-// False: Sending thread is paused/stopped and is not sending dummy messages
+// False: Sending thread is paused/stopped and is not sending dummy messages.
// Returns:
// - error - if the DummyTraffic.SetStatus is called too frequently, causing the
// internal status channel to fill.
--
GitLab