docs: add comments

open-telemetry · Aug 23, 2024 · 9780e3a · 9780e3a
1 parent 06080cf
commit 9780e3a
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 1 deletion.
diff --git a/client/internal/httpsender.go b/client/internal/httpsender.go
@@ -276,6 +276,7 @@ func (h *HTTPSender) receiveResponse(ctx context.Context, resp *http.Response) {
 }
 
 func (h *HTTPSender) SetHeartbeatInterval(duration time.Duration) {
+	// 0 is invalid for a http sender
 	if duration != 0 {
 		h.SetPollingInterval(duration)
 	}

diff --git a/client/internal/wssender.go b/client/internal/wssender.go
@@ -73,7 +73,7 @@ func (s *WSSender) StoppingErr() error {
 	return s.err
 }
 
-// SetHeartbeatInterval ...
+// SetHeartbeatInterval sets the heartbeat interval and triggers timer reset.
 func (s *WSSender) SetHeartbeatInterval(d time.Duration) {
 	s.heartbeatIntervalSeconds.Store(int64(d.Seconds()))
 	select {