document to_plotly_json encoder

chriddyp · chriddyp · commit 97dc235092c8 · 2014-12-12T13:11:22.000-08:00
diff --git a/plotly/utils.py b/plotly/utils.py
@@ -172,12 +172,18 @@ def sageJSONEncoder(self, obj):
             raise NotEncodable
 
     def builtinJSONEncoder(self, obj):
+        '''
+        Provide an API for folks to write their own
+        JSON encoders for their objects that they wanna
+        send to Plotly: this is an object's `to_plotly_json` method
+
+        Used for grid_objs.Column objects.
+        '''
         try:
             return obj.to_plotly_json()
         except AttributeError:
             raise NotEncodable
 
-
     def default(self, obj):
         encoders = (self.builtinJSONEncoder,
                     self.datetimeJSONEncoder,
