betodealmeida commented on a change in pull request #4777: [doc] module header 
for controls.jsx and visTypes.jsx
URL: 
https://github.com/apache/incubator-superset/pull/4777#discussion_r179855277
 
 

 ##########
 File path: superset/assets/javascripts/explore/stores/controls.jsx
 ##########
 @@ -1,3 +1,43 @@
+/**
+ * This file exports all controls available for use in the different 
visualization types
+ *
+ * While the React components located in `controls/components` represent 
different
+ * types of controls (CheckboxControl, SelectControl, TextControl, ...), the 
controls here
+ * represent instances of control types, that can be reused across 
visualisation types.
+ *
+ * When controls are reused across viz types, their values are carried over as 
a user
+ * changes the chart types.
+ *
+ * While the keys defined in the control itself get passed to the controlType 
as props,
+ * here's a list of the keys that are common to all controls,
+ * and as a result define the control interface:
 
 Review comment:
   The flow of text in lines 12/13 is weird, you might wanna move some of the 
text in line 13 to line 12.

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org


With regards,
Apache Git Services

Reply via email to