From 5fe860ed26a4ecebc9ca105e45766eb0183dfa6b Mon Sep 17 00:00:00 2001
From: Jonathan Frederic <jdfreder@calpoly.edu>
Date: Tue, 21 Jan 2014 14:16:24 -0800
Subject: [PATCH] Added doc strings to properties in widget.py
---
IPython/html/widgets/widget.py | 7 +++++++
1 file changed, 7 insertions(+)
diff --git a/IPython/html/widgets/widget.py b/IPython/html/widgets/widget.py
index b2846dedb..4a9c99669 100644
--- a/IPython/html/widgets/widget.py
+++ b/IPython/html/widgets/widget.py
@@ -77,6 +77,7 @@ class Widget(LoggingConfigurable):
#-------------------------------------------------------------------------
@property
def keys(self):
+ """Gets a list of the traitlets that should be synced with the front-end."""
if self._keys is None:
self._keys = []
for trait_name in self.trait_names():
@@ -86,6 +87,9 @@ class Widget(LoggingConfigurable):
@property
def comm(self):
+ """Gets the Comm associated with this widget.
+
+ If a Comm doesn't exist yet, a Comm will be created automagically."""
if self._comm is None:
# Create a comm.
self._comm = Comm(target_name=self.model_name)
@@ -99,6 +103,9 @@ class Widget(LoggingConfigurable):
@property
def model_id(self):
+ """Gets the model id of this widget.
+
+ If a Comm doesn't exist yet, a Comm will be created automagically."""
return self.comm.comm_id
#-------------------------------------------------------------------------