Skip to content
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

Merged
merged 2 commits into from
Apr 7, 2018

Conversation

mistercrunch
Copy link
Member

No description provided.

@codecov-io
Copy link

codecov-io commented Apr 6, 2018

Codecov Report

Merging #4777 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           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
Impacted Files Coverage Δ
...rset/assets/javascripts/explore/stores/visTypes.js 70.58% <ø> (ø) ⬆️
...set/assets/javascripts/explore/stores/controls.jsx 39.25% <ø> (ø) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 92230b8...609d04e. Read the comment docs.

Copy link
Member

@betodealmeida betodealmeida left a 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
Copy link
Member

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:
Copy link
Member

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.
Copy link
Member

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.
Copy link
Member

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

@mistercrunch mistercrunch merged commit ee15fc8 into apache:master Apr 7, 2018
@mistercrunch mistercrunch deleted the document_controls branch April 7, 2018 19:56
michellethomas pushed a commit to michellethomas/panoramix that referenced this pull request May 24, 2018
* Provide much needed module header for the controls.jsx module

* Typos
timifasubaa pushed a commit to timifasubaa/incubator-superset that referenced this pull request May 31, 2018
* Provide much needed module header for the controls.jsx module

* Typos
wenchma pushed a commit to wenchma/incubator-superset that referenced this pull request Nov 16, 2018
* Provide much needed module header for the controls.jsx module

* Typos
@mistercrunch mistercrunch added 🏷️ bot A label used by `supersetbot` to keep track of which PR where auto-tagged with release labels 🚢 0.25.0 labels Feb 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🏷️ bot A label used by `supersetbot` to keep track of which PR where auto-tagged with release labels 🚢 0.25.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants