From 2106b8da3ab0b1e2cfe7013ef0f47b1694d39854 Mon Sep 17 00:00:00 2001
From: James Lu <GLolol1@hotmail.com>
Date: Wed, 15 Jul 2015 14:00:40 -0700
Subject: [PATCH] main: add a note about irc.connected.wait() and maxnicklen
 being set

---
 main.py | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/main.py b/main.py
index 515a946..6a23f67 100755
--- a/main.py
+++ b/main.py
@@ -37,6 +37,12 @@ class Irc():
         self.umodes = {'invisible': 'i', 'snomask': 's', 'wallops': 'w',
                        'oper': 'o',
                        '*A': '', '*B': '', '*C': 's', '*D': 'iow'}
+        # This nicklen value is only a default, and SHOULD be set by the
+        # protocol module as soon as the relevant capability information is
+        # received from the uplink. Plugins that depend on maxnicklen being
+        # set MUST call "irc.connected.wait()", which blocks until the
+        # capability information is received. This handling of irc.connected
+        # is also dependent on the protocol module.
         self.maxnicklen = 30
         self.prefixmodes = 'ov'