Update docs and add changelog

osmosis-labs · Jun 5, 2024 · 0f44dbf · 0f44dbf
1 parent 9156eec
commit 0f44dbf
Show file tree

Hide file tree

Showing 2 changed files with 1 addition and 4 deletions.
diff --git a/.changelog/unreleased/improvements/3182-remove-switch-broadcast-return-channel.md b/.changelog/unreleased/improvements/3182-remove-switch-broadcast-return-channel.md
diff --git a/p2p/switch.go b/p2p/switch.go
@@ -262,10 +262,7 @@ func (sw *Switch) OnStop() {
 // Peers
 
 // BroadcastEnvelope runs a go routine for each attempted send, which will block trying
-// to send for defaultSendTimeoutSeconds. Returns a channel which receives
-// success values for each attempted send (false if times out). Channel will be
-// closed once msg bytes are sent to all peers (or time out).
-// BroadcastEnvelopes sends to the peers using the SendEnvelope method.
+// to send for defaultSendTimeoutSeconds.
 //
 // NOTE: BroadcastEnvelope uses goroutines, so order of broadcast may not be preserved.
 func (sw *Switch) BroadcastEnvelope(e Envelope) {