Merge pull request #302 from seb3s/patch-2

axelson · web-flow · commit 99725e1c9f13 · 2023-03-13T19:00:51.000-10:00
Patch 2
diff --git a/lib/scenic/primitive/arc.ex b/lib/scenic/primitive/arc.ex
@@ -37,8 +37,9 @@ defmodule Scenic.Primitive.Arc do
 
   This primitive recognizes the following styles
   * [`hidden`](Scenic.Primitive.Style.Hidden.html) - show or hide the primitive
+  * [`scissor`](Scenic.Primitive.Style.Scissor.html) - "scissor rectangle" that drawing will be clipped to.
   * [`fill`](Scenic.Primitive.Style.Fill.html) - fill in the area of the primitive
-  * [`stroke`](Scenic.Primitive.Style.Stroke.html) - stroke the outline of the primitive. In this case, only the curvy part.  
+  * [`stroke`](Scenic.Primitive.Style.Stroke.html) - stroke the outline of the primitive. In this case, only the curvy part.
 
   ## Usage
 
diff --git a/lib/scenic/primitive/circle.ex b/lib/scenic/primitive/circle.ex
@@ -18,6 +18,7 @@ defmodule Scenic.Primitive.Circle do
 
   This primitive recognizes the following styles
   * [`hidden`](Scenic.Primitive.Style.Hidden.html) - show or hide the primitive
+  * [`scissor`](Scenic.Primitive.Style.Scissor.html) - "scissor rectangle" that drawing will be clipped to.
   * [`fill`](Scenic.Primitive.Style.Fill.html) - fill in the area of the primitive
   * [`stroke`](Scenic.Primitive.Style.Stroke.html) - stroke the outline of the primitive. In this case, only the curvy part.
 
diff --git a/lib/scenic/primitive/ellipse.ex b/lib/scenic/primitive/ellipse.ex
@@ -19,6 +19,7 @@ defmodule Scenic.Primitive.Ellipse do
 
   This primitive recognizes the following styles
   * [`hidden`](Scenic.Primitive.Style.Hidden.html) - show or hide the primitive
+  * [`scissor`](Scenic.Primitive.Style.Scissor.html) - "scissor rectangle" that drawing will be clipped to.
   * [`fill`](Scenic.Primitive.Style.Fill.html) - fill in the area of the primitive
   * [`stroke`](Scenic.Primitive.Style.Stroke.html) - stroke the outline of the primitive. In this case, only the curvy part.
 
diff --git a/lib/scenic/primitive/line.ex b/lib/scenic/primitive/line.ex
@@ -19,6 +19,7 @@ defmodule Scenic.Primitive.Line do
 
   This primitive recognizes the following styles
   * [`hidden`](Scenic.Primitive.Style.Hidden.html) - show or hide the primitive
+  * [`scissor`](Scenic.Primitive.Style.Scissor.html) - "scissor rectangle" that drawing will be clipped to.
   * [`cap`](Scenic.Primitive.Style.Cap.html) - says how to draw the ends of the line.
   * [`stroke`](Scenic.Primitive.Style.Stroke.html) - stroke the outline of the primitive. In this case, only the curvy part.
 
diff --git a/lib/scenic/primitive/path.ex b/lib/scenic/primitive/path.ex
@@ -18,6 +18,7 @@ defmodule Scenic.Primitive.Path do
 
   This primitive recognizes the following styles
   * [`hidden`](Scenic.Primitive.Style.Hidden.html) - show or hide the primitive
+  * [`scissor`](Scenic.Primitive.Style.Scissor.html) - "scissor rectangle" that drawing will be clipped to.
   * [`fill`](Scenic.Primitive.Style.Fill.html) - fill in the area of the primitive
   * [`stroke`](Scenic.Primitive.Style.Stroke.html) - stroke the outline of the primitive. In this case, only the curvy part.
   * [`cap`](Scenic.Primitive.Style.Cap.html) - says how to draw the ends of the line.
diff --git a/lib/scenic/primitive/quad.ex b/lib/scenic/primitive/quad.ex
@@ -21,6 +21,7 @@ defmodule Scenic.Primitive.Quad do
 
   This primitive recognizes the following styles
   * [`hidden`](Scenic.Primitive.Style.Hidden.html) - show or hide the primitive
+  * [`scissor`](Scenic.Primitive.Style.Scissor.html) - "scissor rectangle" that drawing will be clipped to.
   * [`fill`](Scenic.Primitive.Style.Fill.html) - fill in the area of the primitive
   * [`stroke`](Scenic.Primitive.Style.Stroke.html) - stroke the outline of the primitive. In this case, only the curvy part.
   * [`join`](Scenic.Primitive.Style.Join.html) - control how segments are joined.
diff --git a/lib/scenic/primitive/rectangle.ex b/lib/scenic/primitive/rectangle.ex
@@ -19,6 +19,7 @@ defmodule Scenic.Primitive.Rectangle do
 
   This primitive recognizes the following styles
   * [`hidden`](Scenic.Primitive.Style.Hidden.html) - show or hide the primitive
+  * [`scissor`](Scenic.Primitive.Style.Scissor.html) - "scissor rectangle" that drawing will be clipped to.
   * [`fill`](Scenic.Primitive.Style.Fill.html) - fill in the area of the primitive
   * [`stroke`](Scenic.Primitive.Style.Stroke.html) - stroke the outline of the primitive. In this case, only the curvy part.
   * [`join`](Scenic.Primitive.Style.Join.html) - control how segments are joined.
diff --git a/lib/scenic/primitive/rounded_rectangle.ex b/lib/scenic/primitive/rounded_rectangle.ex
@@ -20,6 +20,7 @@ defmodule Scenic.Primitive.RoundedRectangle do
 
   This primitive recognizes the following styles
   * [`hidden`](Scenic.Primitive.Style.Hidden.html) - show or hide the primitive
+  * [`scissor`](Scenic.Primitive.Style.Scissor.html) - "scissor rectangle" that drawing will be clipped to.
   * [`fill`](Scenic.Primitive.Style.Fill.html) - fill in the area of the primitive
   * [`stroke`](Scenic.Primitive.Style.Stroke.html) - stroke the outline of the primitive. In this case, only the curvy part.
 
diff --git a/lib/scenic/primitive/sector.ex b/lib/scenic/primitive/sector.ex
@@ -29,6 +29,7 @@ defmodule Scenic.Primitive.Sector do
 
   This primitive recognizes the following styles
   * [`hidden`](Scenic.Primitive.Style.Hidden.html) - show or hide the primitive
+  * [`scissor`](Scenic.Primitive.Style.Scissor.html) - "scissor rectangle" that drawing will be clipped to.
   * [`fill`](Scenic.Primitive.Style.Fill.html) - fill in the area of the primitive
   * [`stroke`](Scenic.Primitive.Style.Stroke.html) - stroke the outline of the primitive. In this case, only the curvy part.
 
diff --git a/lib/scenic/primitive/sprites.ex b/lib/scenic/primitive/sprites.ex
@@ -43,10 +43,10 @@ defmodule Scenic.Primitive.Sprites do
   Sprites are common in the game industry and can be used to
   create animations, manage large numbers of small images and more.
 
-  For example, in many games a character walking is built as a  series
+  For example, in many games a character walking is built as a series
   of frames in an animation that all live together in a single image
   file. When it comes time to draw, the different frames are rendered
-  to the screen on after the other to give the appearance that the
+  to the screen one after the other to give the appearance that the
   character is animating.
 
   A simpler example would be an image of a device with a blinking
diff --git a/lib/scenic/primitive/style/miter_limit.ex b/lib/scenic/primitive/style/miter_limit.ex
@@ -11,7 +11,7 @@ defmodule Scenic.Primitive.Style.MiterLimit do
 
   ```elixir
   graph
-    |> triangle( {{0,40},{40,40},{40,0}}
+    |> triangle({{0, 40}, {40, 40}, {40, 0}},
       miter_limit: 2,
       stroke: {2, :green}
     )
diff --git a/lib/scenic/primitive/style/scissor.ex b/lib/scenic/primitive/style/scissor.ex
@@ -11,7 +11,7 @@ defmodule Scenic.Primitive.Style.Scissor do
 
   ```elixir
   graph
-    |> triangle( {{0,40},{40,40},{40,0}}
+    |> triangle({{0, 40}, {40, 40}, {40, 0}},
       miter_limit: 2,
       fill: :green,
       scissor: {20, 40}
diff --git a/lib/scenic/primitive/text.ex b/lib/scenic/primitive/text.ex
@@ -18,6 +18,7 @@ defmodule Scenic.Primitive.Text do
 
   This primitive recognizes the following styles
   * [`hidden`](Scenic.Primitive.Style.Hidden.html) - show or hide the primitive
+  * [`scissor`](Scenic.Primitive.Style.Scissor.html) - "scissor rectangle" that drawing will be clipped to.
   * [`fill`](Scenic.Primitive.Style.Fill.html) - fill in the area of the text. Only solid colors!
   * [`font`](Scenic.Primitive.Style.Font.html) - name (or key) of font to use
   * [`font_size`](Scenic.Primitive.Style.FontSize.html) - point size of the font
diff --git a/lib/scenic/primitive/triangle.ex b/lib/scenic/primitive/triangle.ex
@@ -20,6 +20,7 @@ defmodule Scenic.Primitive.Triangle do
 
   This primitive recognizes the following styles
   * [`hidden`](Scenic.Primitive.Style.Hidden.html) - show or hide the primitive
+  * [`scissor`](Scenic.Primitive.Style.Scissor.html) - "scissor rectangle" that drawing will be clipped to.
   * [`fill`](Scenic.Primitive.Style.Fill.html) - fill in the area of the primitive
   * [`stroke`](Scenic.Primitive.Style.Stroke.html) - stroke the outline of the primitive. In this case, only the curvy part.
   * [`join`](Scenic.Primitive.Style.Join.html) - control how segments are joined.
