Merge pull request godbus#294 from godbus/doc/signal_ownership

doc: clarify Signal channel behavior
kolyshkin · Jan 7, 2022 · 6b744b9 · 6b744b9
2 parents b98979d + cefe07c
commit 6b744b9
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/conn.go b/conn.go
@@ -650,7 +650,9 @@ func (conn *Conn) RemoveMatchSignalContext(ctx context.Context, options ...Match
 
 // Signal registers the given channel to be passed all received signal messages.
 //
-// Multiple of these channels can be registered at the same time.
+// Multiple of these channels can be registered at the same time. The channel is
+// closed if the Conn is closed; it should not be closed by the caller before
+// RemoveSignal was called on it.
 //
 // These channels are "overwritten" by Eavesdrop; i.e., if there currently is a
 // channel for eavesdropped messages, this channel receives all signals, and