Add constructor comment for widget model.

12 years ago · 3a271585d7
parent d7835eb14e
commit 3a271585d7
1 changed files with 10 additions and 0 deletions
--- a/IPython/html/static/notebook/js/widgets/widget.js
+++ b/IPython/html/static/notebook/js/widgets/widget.js
@ -24,6 +24,16 @@ function(widget_manager, underscore, backbone){
    //--------------------------------------------------------------------
    var WidgetModel = Backbone.Model.extend({
        constructor: function (widget_manager, model_id, comm) {
+            // Construcctor
+            //
+            // Creates a WidgetModel instance.
+            //
+            // Parameters
+            // ----------
+            // widget_manager : WidgetManager instance
+            // model_id : string
+            //      An ID unique to this model.
+            // comm : Comm instance (optional)
            this.widget_manager = widget_manager;
            this.pending_msgs = 0;
            this.msg_throttle = 3;