Doc fixes: colorRange and Readme.md (visgl#2172)

* Misc doc fixes
mpearson · Aug 10, 2018 · ef59c62 · ef59c62
1 parent 5ecb89c
commit ef59c62
Show file tree

Hide file tree

Showing 4 changed files with 4 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -49,7 +49,7 @@ const flights = new ArcLayer({
 
 Simple usage of deck.gl is also showcased in the [hello-world examples](./examples/get-started), using both [webpack2](./examples/get-started/react-webpack-2) and [browserify](./examples/get-started/react-browserify), so you can choose which bundler you prefer or are more familiar with.
 
-To learn how to use deck.gl through the many examples that coming with the deck.gl repo, please clone the latest **release** branch. `git clone -b 5.3-release --single-branch https://github.com/uber/deck.gl.git`
+To learn how to use deck.gl through the many examples that coming with the deck.gl repo, please clone the latest **release** branch. `git clone -b 6.0-release --single-branch https://github.com/uber/deck.gl.git`
 
 For the most up-to-date information, see our [docs](http://uber.github.io/deck.gl/#/docs/getting-started/installation?section=running-the-examples)
 

diff --git a/docs/layers/grid-layer.md b/docs/layers/grid-layer.md
@@ -64,7 +64,7 @@ Color scale domain, default is set to the range of point counts in each cell.
 
 * Default: <img src="/website/src/static/images/colorbrewer_YlOrRd_6.png"/></a>
 
-Color ranges as an array of colors formatted as `[255, 255, 255]`. Default is
+Specified as an array of 6 colors [color1, color2, ... color6]. Each color is an array of 3 or 4 values [R, G, B] or [R, G, B, A], representing intensities of Red, Green, Blue and Alpha channels.  Each intensity is a value between 0 and 255. When Alpha not provided a value of 255 is used. By default `colorRange` is set to
 [colorbrewer](http://colorbrewer2.org/#type=sequential&scheme=YlOrRd&n=6) `6-class YlOrRd`.
 
 ##### `coverage` (Number, optional)
@@ -204,5 +204,3 @@ This callback will be called when bin elevation domain has been calculated.
 ## Source
 
 [modules/layers/src/grid-layer](https://github.com/uber/deck.gl/tree/master/modules/layers/src/grid-layer)
-
-
diff --git a/docs/layers/hexagon-layer.md b/docs/layers/hexagon-layer.md
@@ -80,7 +80,7 @@ to number of counts by passing in an arbitrary color domain. This property is ex
 
 * Default: <img src="/website/src/static/images/colorbrewer_YlOrRd_6.png"/></a>
 
-Hexagon color ranges as an array of colors formatted as `[[255, 255, 255, 255]]`. Default is
+Specified as an array of 6 colors [color1, color2, ... color6]. Each color is an array of 3 or 4 values [R, G, B] or [R, G, B, A], representing intensities of Red, Green, Blue and Alpha channels.  Each intensity is a value between 0 and 255. When Alpha not provided a value of 255 is used. By default `colorRange` is set to
 [colorbrewer](http://colorbrewer2.org/#type=sequential&scheme=YlOrRd&n=6) `6-class YlOrRd`.
 
 ##### `coverage` (Number, optional)

diff --git a/docs/layers/screen-grid-layer.md b/docs/layers/screen-grid-layer.md
@@ -82,7 +82,7 @@ to value of its weight by passing in an arbitrary color domain. This property is
 
 * Default: <img src="/website/src/static/images/colorbrewer_YlOrRd_6.png"/></a>
 
-Specified as an array of colors formatted as `[[255, 255, 255, 255]]`. Default is
+Specified as an array of 6 colors [color1, color2, ... color6]. Each color is an array of 3 or 4 values [R, G, B] or [R, G, B, A], representing intensities of Red, Green, Blue and Alpha channels.  Each intensity is a value between 0 and 255. When Alpha not provided a value of 255 is used. By default `colorRange` is set to
 [colorbrewer](http://colorbrewer2.org/#type=sequential&scheme=YlOrRd&n=6) `6-class YlOrRd`.
 
 NOTE: `minColor` and `maxColor` take precedence over `colorDomain` and `colorRange`, to use `colorDomain` and `colorRange` do not provide `minColor` and `maxColor`.