Doc update.
authorChris Jones <christian.jones@sri.com>
Mon, 09 Sep 2013 04:18:29 +0100
changeset 138 065f54e291c7
parent 137 c94a7ce0f4fb
child 139 12c48d1157dc
Doc update.
xmpp/xmpp.go
--- a/xmpp/xmpp.go	Mon Sep 09 04:17:06 2013 +0100
+++ b/xmpp/xmpp.go	Mon Sep 09 04:18:29 2013 +0100
@@ -99,8 +99,9 @@
 // with the given password. This function will return as soon as a TCP
 // connection has been established, but before XMPP stream negotiation
 // has completed. The negotiation will occur asynchronously, and any
-// send operation to Client.Out will block until negotiation (resource
-// binding) is complete.
+// send operation to Client.Send will block until negotiation
+// (resource binding) is complete. The caller must immediately start
+// reading from Client.Recv.
 func NewClient(jid *JID, password string, tlsconf tls.Config, exts []Extension) (*Client, error) {
 	// Include the mandatory extensions.
 	roster := newRosterExt()