Merge branch 'v0.11' into fix-divide-by-zero

Author: boydm

lib/scenic/color.ex

@@ -156,6 +156,13 @@ defmodule Scenic.Color do
     yellow_green: {0x9A, 0xCD, 0x32}
   }
 
+  @g :color_g
+  @ga :color_ga
+  @rgb :color_rgb
+  @rgba :color_rgba
+  @hsv :color_hsv
+  @hsl :color_hsl
+
   @moduledoc """
   APIs to create and work with colors.
 
@@ -180,15 +187,15 @@ defmodule Scenic.Color do
   For HSL and HSV, h is a float between 0 and 360, while the s, v and l values
   are floats between 0 and 100.
 
-  | Format          | Implicit | Explicit  |
-  |---------------|------------------------|-----------|
-  | Named Color | *na* | See the Named Color Table |
-  | Grayscale | `g` | `{:g, g}` |
-  | Gray, Alpha | `{g, a}` | `{:g, {g, a}}` |
-  | Red, Green, Blue | `{r, g, b}` | `{:rgb, {r, g, b}}` |
-  | Red, Green, Blue, Alpha | `{r, g, b, a}` | `{:rgba, {r, g, b, a}}` |
-  | Hue, Saturation, Value | *na* | `{:hsv, {h, s, v}}` |
-  | Hue, Saturation, Lightness | *na* | `{:hsl, {h, s, l}}` |
+  | Format                     | Implicit       | Explicit                    |
+  |----------------------------|----------------|-----------------------------|
+  | Named Color                | *na*           | See the Named Color Table   |
+  | Grayscale                  | `g`            | `{:#{@g}, g}`               |
+  | Gray, Alpha                | `{g, a}`       | `{:#{@ga}, {g, a}}`         |
+  | Red, Green, Blue           | `{r, g, b}`    | `{:#{@rgb}, {r, g, b}}`     |
+  | Red, Green, Blue, Alpha    | `{r, g, b, a}` | `{:#{@rgba}, {r, g, b, a}}` |
+  | Hue, Saturation, Value     | *na*           | `{:#{@hsv}, {h, s, v}}`     |
+  | Hue, Saturation, Lightness | *na*           | `{:#{@hsl}, {h, s, l}}`     |
 
 
   ## Named Colors
@@ -204,19 +211,18 @@ defmodule Scenic.Color do
 
   ## Additional Named Colors
 
-    | Name          | Value                  |
-  |---------------|------------------------|
-  | `:clear` | `{0x80, 0x80, 0x80, 0x00}` |
+  | Name          | Value                       |
+  |---------------|-----------------------------|
+  | `:clear` | `{0x80, 0x80, 0x80, 0x00}`       |
   | `:transparent` | `{0x80, 0x80, 0x80, 0x00}` |
 
   ## Converting Between Color Formats
 
-  By using the functions `to_g`, `to_ga`, `to_rgb`, `to_rgb`, `to_hsl`, and `to_hsv`
-  you can convert between any implicit or explicit color type to any explicit color type.
+  By using the functions `to_g/1`, `to_ga/1`, `to_rgb/1`, `to_rgb/1`,
+  `to_hsl/1`, and `to_hsv/1` you can convert between any implicit or explicit
+  color type to any explicit color type.
   """
-
-  # import IEx
-
+  
   @g :color_g
   @ga :color_ga
   @rgb :color_rgb

lib/scenic/component.ex

@@ -210,12 +210,8 @@ defmodule Scenic.Component do
       # --------------------------------------------------------
       defoverridable add_to_graph: 3
     end
-
-    # quote
   end
 
-  # defmacro
-
   @filter_out [
     :cap,
     :fill,
@@ -240,7 +236,6 @@ defmodule Scenic.Component do
   # prepare the list of opts to send to a component as it is being started up
   # the main task is to remove styles that have already been consumed or don't make
   # sense, while leaving any opts/styles that are intended for the component itself.
-  # also, add the viewport as an option.
   @doc false
   @spec filter_opts(opts :: Keyword.t()) :: Keyword.t()
   def filter_opts(opts) when is_list(opts) do

lib/scenic/graph.ex

@@ -68,8 +68,9 @@ defmodule Scenic.Graph do
   that new primitives added to it are inserted into the new group instead of the
   root of the graph.
 
-  Finally, when the group is finished, a translation matrix and a `:text_align` style
-  are added to it. These properties are _inherited_ by the primitives in the group.
+  Finally, when the group is finished, a translation matrix and a `:text_align`
+  style (see `Scenic.Primitive.Style.TextAlign`) are added to it. These
+  properties are _inherited_ by the primitives in the group.
 
   ## Inheritance
 

lib/scenic/primitive/style/text_align.ex

@@ -11,7 +11,7 @@ defmodule Scenic.Primitive.Style.TextAlign do
 
   ```elixir
   graph
-    |> text( "Some Text", text_align: :center_middle )
+  |> text("Some Text", text_align: :center)
   ```
 
   ### Data Format

lib/scenic/primitives.ex

@@ -1195,8 +1195,8 @@ defmodule Scenic.Primitives do
     then draw it again without blur, slightly offset, you get a nice drop shadow
     effect. The default is to draw with no blur.
   * `:text_align` - Specify the alignment of the text you are drawing. You will
-    usually specify one of: `:left`, `:center`, or `:right`. You can also specify
-    vertical alignment. See `Scenic.Primitive.Style.TextAlign` for details.
+    usually specify one of: `:left`, `:center`, or `:right`. See
+    `Scenic.Primitive.Style.TextAlign` for details.
   * `:text_height` - Specify the vertical spacing between rows of text.
 
 

lib/scenic/script.ex

@@ -19,8 +19,8 @@ defmodule Scenic.Script do
 
   Simply put, Scenic.Script produces a list of static drawing commands that are
   sent, unmodified, to the drivers through the ViewPort. These scripts are
-  generated for you when you use push_graph, or you can create them yourself
-  by using this api.
+  generated for you when you use `Scenic.Scene.push_graph/3`, or you can create
+  them yourself by using this api.
 
   If you use Scenic.Script directly, you can create more complicated and/or
   reusable graphics than you could by using Graphs alone.
@@ -31,17 +31,17 @@ defmodule Scenic.Script do
   that which changes frequently. When a graph is pushed to the ViewPort, the 
   entire thing is compiled into a script, which is sent as a whole to the Drivers.
 
-  If that graph references a script tho, only the reference is sent, not the contents
-  of the script. This means you can modify the graph frequently without sending
-  the contents of the scripts.
+  However if that graph references a script, only the reference to the script is
+  sent, not the contents of the script. This means you can modify the graph
+  frequently without sending the contents of the scripts.
 
   The opposite is also true. You can generate and push the scripts frequently
   without causing the graphs that reference them to be recompiled or resent.
 
-  And example of this might be a graph that implements a chart of some sort.
-
-  The contents of the chart could be a script that is updated as new data comes
-  in without needed all the chrome around it to be recompiled or sent.
+  An example of this might be a graph that implements a chart of some sort. The
+  contents of the chart could be a script that is updated as new data comes in
+  without needing all the chrome around it to be recompiled or sent for every
+  update.
 
   ## API Patterns