-
Notifications
You must be signed in to change notification settings - Fork 14k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[doc] module header for controls.jsx and visTypes.jsx #4777
Conversation
Codecov Report
@@ Coverage Diff @@
## master #4777 +/- ##
=======================================
Coverage 72.59% 72.59%
=======================================
Files 205 205
Lines 15401 15401
Branches 1183 1183
=======================================
Hits 11180 11180
Misses 4218 4218
Partials 3 3
Continue to review full report at Codecov.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good, just some minor comments on typos.
@@ -1,3 +1,7 @@ | |||
/** | |||
* This file defines how controls (defined in controls.js) are structured into sections |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
control.jsx
* | ||
* 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: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The flow of text in lines 12/13 is weird, you might wanna move some of the text in line 13 to line 12.
and fetch the data | ||
* - validators: an array of functions that will receive the value of the component and | ||
should return error messages when the value is not valid. The error message gets | ||
bubble up to the control header, section header and query panel header. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
bubbled up
* Note that the keys defined in controls in this file that are not listed above represent | ||
* props specific for the React component defined as `type`. Also note that this module work | ||
* in tandem with `visTypes.js` that defines how controls are composed into sections for | ||
* each and every visualization types. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
each and every visualization type
* Provide much needed module header for the controls.jsx module * Typos
* Provide much needed module header for the controls.jsx module * Typos
* Provide much needed module header for the controls.jsx module * Typos
No description provided.