Merge pull request #1207 from jasongrout/schema

WIP: Document of the attributes for each model

Author: jasongrout

ipywidgets/widgets/domwidget.py

@@ -13,7 +13,7 @@ class DOMWidget(Widget):
     """Widget that can be inserted into the DOM"""
 
     _model_name = Unicode('DOMWidgetModel').tag(sync=True)
-    _dom_classes = Tuple(help="DOM classes applied to widget.$el.").tag(sync=True)
+    _dom_classes = Tuple(help="CSS classes applied to widget DOM element").tag(sync=True)
     layout = LayoutTraitType().tag(sync=True, **widget_serialization)
 
     @default('layout')

ipywidgets/widgets/widget_box.py

@@ -25,7 +25,7 @@ class Box(DOMWidget, CoreWidget):
     # Child widgets in the container.
     # Using a tuple here to force reassignment to update the list.
     # When a proper notifying-list trait exists, that is what should be used here.
-    children = Tuple().tag(sync=True, **widget_serialization)
+    children = Tuple().tag(sync=True, help="List of widget children", **widget_serialization)
 
     box_style = CaselessStrEnum(
         values=['success', 'info', 'warning', 'danger', ''], default_value='',

ipywidgets/widgets/widget_button.py

@@ -21,7 +21,7 @@
 class ButtonStyle(Style, CoreWidget):
     """Button style widget."""
     _model_name = Unicode('ButtonStyleModel').tag(sync=True)
-    button_color = Color(None, allow_none=True).tag(sync=True)
+    button_color = Color(None, allow_none=True, help="Color of the button").tag(sync=True)
     font_weight = Unicode().tag(sync=True)
 
 

ipywidgets/widgets/widget_float.py

@@ -174,8 +174,8 @@ class FloatProgress(_BoundedFloat):
 
     bar_style = CaselessStrEnum(
         values=['success', 'info', 'warning', 'danger', ''],
-        default_value='', allow_none=True, help="""Use a predefined styling for
-        the progess bar.""").tag(sync=True)
+        default_value='', allow_none=True,
+        help="Use a predefined styling for the progess bar.").tag(sync=True)
 
     style = Instance(ProgressStyle).tag(sync=True, **widget_serialization)
 

ipywidgets/widgets/widget_link.py

@@ -15,6 +15,8 @@
 class WidgetTraitTuple(Tuple):
     """Traitlet for validating a single (Widget, 'trait_name') pair"""
 
+    info_text = "A (Widget, 'trait_name') pair"
+
     def __init__(self, **kwargs):
         super(WidgetTraitTuple, self).__init__(Instance(Widget), Unicode, **kwargs)
 
@@ -43,8 +45,8 @@ class Link(CoreWidget):
     _model_module = Unicode('jupyter-js-widgets').tag(sync=True)
     _view_module = Unicode('jupyter-js-widgets').tag(sync=True)
     _model_name = Unicode('LinkModel').tag(sync=True)
-    target = WidgetTraitTuple().tag(sync=True, **widget_serialization)
-    source = WidgetTraitTuple().tag(sync=True, **widget_serialization)
+    target = WidgetTraitTuple(help="The target (widget, 'trait_name') pair").tag(sync=True, **widget_serialization)
+    source = WidgetTraitTuple(help="The source (widget, 'trait_name') pair").tag(sync=True, **widget_serialization)
 
     def __init__(self, source, target, **kwargs):
         kwargs['source'] = source

ipywidgets/widgets/widget_output.py

@@ -38,7 +38,7 @@ class Output(DOMWidget, CoreWidget):
     _model_name = Unicode('OutputModel').tag(sync=True)
     _model_module = Unicode('jupyter-js-widgets').tag(sync=True)
     _view_module = Unicode('jupyter-js-widgets').tag(sync=True)
-    msg_id = Unicode('').tag(sync=True)
+    msg_id = Unicode('', help="Parent message id of messages to capture").tag(sync=True)
 
     def clear_output(self, *pargs, **kwargs):
         with self:

ipywidgets/widgets/widget_selection.py

@@ -217,8 +217,7 @@ class ToggleButtons(_Selection):
 
     button_style = CaselessStrEnum(
         values=['primary', 'success', 'info', 'warning', 'danger', ''],
-        default_value='', allow_none=True, help="""Use a predefined styling for
-        the buttons.""").tag(sync=True)
+        default_value='', allow_none=True, help="""Use a predefined styling for the buttons.""").tag(sync=True)
 
 
 @register('Jupyter.Dropdown')