Improve CRegExp docstring.

bfroehle · May 9, 2012 · 2fc3cff · 2fc3cff
1 parent 9d723ae
commit 2fc3cff
Showing 1 changed file with 4 additions and 1 deletion.
diff --git a/IPython/utils/traitlets.py b/IPython/utils/traitlets.py
@@ -1413,7 +1413,10 @@ def validate(self, obj, value):
         self.error(obj, value)
 
 class CRegExp(TraitType):
-    """A trait for a compiled regular expression."""
+    """A casting compiled regular expression trait.
+
+    Accepts both strings and compiled regular expressions. The resulting
+    attribute will be a compiled regular expression."""
 
     info_text = 'a regular expression'