Merge pull request #13 from pabigot/issue/20210830a

connection: clarify documented behavior of NotifyClose
rabbitmq · Sep 21, 2021 · bb8191b · bb8191b
2 parents 29645df + 4a79eb7
commit bb8191b
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/connection.go b/connection.go
@@ -262,7 +262,8 @@ func (c *Connection) ConnectionState() tls.ConnectionState {
 NotifyClose registers a listener for close events either initiated by an error
 accompanying a connection.close method or by a normal shutdown.
 
-On normal shutdowns, the chan will be closed.
+The chan provided will be closed when the Channel is closed and on a
+graceful close, no error will be sent.
 
 To reconnect after a transport or protocol error, register a listener here and
 re-run your setup process.