From 582b3278ce8c6a9d2f54afc42672dbe18e9f0f12 2009-08-25 22:07:21
From: Brian Granger <ellisonbg@gmail.com>
Date: 2009-08-25 22:07:21
Subject: [PATCH] Minor doc updates.

---

diff --git a/IPython/core/component.py b/IPython/core/component.py
index 83406db..bc33324 100644
--- a/IPython/core/component.py
+++ b/IPython/core/component.py
@@ -191,6 +191,14 @@ class Component(HasTraitlets):
                                      "root != parent.root")
 
     def _config_changed(self, name, old, new):
+        """Update all the class traits having a config_key with the config.
+
+        For any class traitlet with a ``config_key`` metadata attribute, we
+        update the traitlet with the value of the corresponding config entry.
+
+        In the future, we might want to do a pop here so stale config info
+        is not passed onto children.
+        """
         # Get all traitlets with a config_key metadata entry
         traitlets = self.traitlets('config_key')
         for k, v in traitlets.items():