v2: Add deprecation notice to DialStreamContext

SiaFoundation · Sep 16, 2024 · e3a6299 · e3a6299
1 parent b7fef91
commit e3a6299
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/v2/mux.go b/v2/mux.go
@@ -346,6 +346,9 @@ func (m *Mux) DialCovertStream() *Stream {
 //
 // Unlike e.g. net.Dial, this does not perform any I/O; the peer will not be
 // aware of the new Stream until Write is called.
+//
+// Deprecated: To associate a Stream with a context, use a helper function as
+// described here: https://github.com/SiaFoundation/mux/pull/2#issuecomment-2351171318
 func (m *Mux) DialStreamContext(ctx context.Context) *Stream {
 	s := m.DialStream()
 	go func() {