📖 Document that #disconnect joins receiver thread

nevans · nevans · commit 5bddf68a3acd · 2025-06-19T11:58:45.000-04:00
diff --git a/lib/net/imap.rb b/lib/net/imap.rb
@@ -1131,6 +1131,9 @@ def tls_verified?; @tls_verified end
 
     # Disconnects from the server.
     #
+    # Waits for receiver thread to close before returning.  Slow or stuck
+    # response handlers can cause #disconnect to hang until they complete.
+    #
     # Related: #logout, #logout!
     def disconnect
       in_logout_state = try_state_logout?

Original file line number	Diff line number	Diff line change
`@@ -1131,6 +1131,9 @@ def tls_verified?; @tls_verified end`
`1131`	`1131`
`1132`	`1132`	`# Disconnects from the server.`
`1133`	`1133`	`#`
	`1134`	`+ # Waits for receiver thread to close before returning. Slow or stuck`
	`1135`	`+ # response handlers can cause #disconnect to hang until they complete.`
	`1136`	`+ #`
`1134`	`1137`	`# Related: #logout, #logout!`
`1135`	`1138`	`def disconnect`
`1136`	`1139`	`in_logout_state = try_state_logout?`