Skip to content

Commit d6b8798

Browse files
authored
Merge pull request #83 from benstafford/fix-guides-spelling
Fix guides wording and spelling Thank you!
2 parents c593395 + 6e183e4 commit d6b8798

File tree

5 files changed

+16
-16
lines changed

5 files changed

+16
-16
lines changed

guides/getting_started.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ building your first Scenic application.
55

66
## Install `scenic.new`
77

8-
The Scenic Archive is the home of the `scenic.new` mix task, which layout a
8+
The Scenic Archive is the home of the `scenic.new` mix task, which lays out a
99
starter application for you. This is the easiest way to set up a new Scenic
1010
project.
1111

@@ -51,7 +51,7 @@ configurations should live in your app's config.exs file.
5151
]
5252
}
5353

54-
Then use that config for start your supervisor with the `Scenic` supervisor.
54+
Then use that config to start your supervisor with the `Scenic` supervisor.
5555

5656
```elixir
5757
defmodule MyApp do
@@ -112,7 +112,7 @@ Scenic application. It has four scenes, two components, and a simulated sensor.
112112

113113
- **Splash:** The Splash scene is configured to run when the app is started in
114114
the `config/config.exs` file. It runs a simple animation, then transitions to
115-
the Sensor scene. It also shows how intercept basic user input to exit the
115+
the Sensor scene. It also shows how to intercept basic user input to exit the
116116
scene early.
117117

118118
- **Sensor:** The Sensor scene depicts a simulated temperature sensor. The

guides/getting_started_nerves.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1-
Placesholder for getting started with Nerves
1+
Placeholder for getting started with Nerves
22

3-
Coming soon
3+
Coming soon

guides/overview_scene.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Structure of a Scene
22

3-
A `Scenic.Scene` is a `GenServer` process which creates and manages a [Graph](overview_graph.html) that gets drawn to the screen. Scenes also respondss to user input and other events.
3+
A `Scenic.Scene` is a `GenServer` process which creates and manages a [Graph](overview_graph.html) that gets drawn to the screen. Scenes also respond to user input and other events.
44

55
Scenes can reference each other, creating a logical hierarchy that lives above
66
the Graphs themselves. This allows scenes to be reusable, small, and simple. A
@@ -11,7 +11,7 @@ Scenes that are specifically meant to be reused are called components.
1111
Components have sugar apis that make them very easy to use inside of a parent
1212
scene.
1313

14-
For example, if you create a dashboard. It may have buttons, text input,
14+
For example, if you create a dashboard, it may have buttons, text input,
1515
sliders, or other input controls in it. Each of those controls is a component
1616
scene that is dynamically created when the dashboard scene is started. This
1717
collection of scenes forms a graph, which can be quite deep (scenes using scenes
@@ -30,7 +30,7 @@ defines what is to be drawn to the screen, any referenced components, and the
3030
overall draw order. When the Scene decides the graph is ready to be drawn to the
3131
screen, it pushes it to the Viewport.
3232

33-
In general, a graph is immutable data structure that you manipulate through
33+
In general, a graph is an immutable data structure that you manipulate through
3434
transform functions. In the example below `Graph.build()` creates an empty
3535
graph, which is piped into functions that add things to it. The `text/3`
3636
function accepts a graph, adds some text to it, then applies a list of options
@@ -130,7 +130,7 @@ option | description
130130
----------- | -----------
131131
`:id` | If this scene is a component, then the id that was assigned to its reference in the parent's graph is passed in as the `:id` option. Typically, controls that generate and send events to its parent scene use this id to identify themselves. If this is the root scene, the id will not be set.
132132
`:styles` | This is the map of styles inherited from the parent graph. The scene can use these styles (or not) as makes sense for its needs.
133-
`:viewport` | This is gives the pid of the viewport running this scene. It is very useful if you want to generate input or change the currently showing scene. If you are managing the scene in your own supervisor, it will not be set. See [life-cycle of a scene](scene_lifecycle.html) for more information.
133+
`:viewport` | This gives the pid of the viewport running this scene. It is very useful if you want to generate input or change the currently showing scene. If you are managing the scene in your own supervisor, it will not be set. See [life-cycle of a scene](scene_lifecycle.html) for more information.
134134

135135
## Pushing a Graph
136136

@@ -183,7 +183,7 @@ event that you handle.
183183
## User Input
184184

185185
A Scene also responds to messages. The two types of messages Scenic will send to
186-
scene are user input, and events.
186+
the scene are user input and events.
187187

188188
## Events
189189

@@ -198,7 +198,7 @@ to use from within another scene. To make a component, call the
198198
`use Scenic.Component` macro instead of the Scene version.
199199

200200
You will then need to add `info/0` and `verify/1` callbacks. The `verify/1`
201-
accepts the `scene_args`parameter that will be passed to the `init/2` function,
201+
accepts the `scene_args` parameter that will be passed to the `init/2` function
202202
and verifies that it is correctly formatted. If it is correct, return
203203
`{:ok, data}`. If it is not ok, return `:invalid_data`.
204204

@@ -274,5 +274,5 @@ With helper functions, the above graph would be re-written like this:
274274
## What to read next?
275275

276276
Next, you should read about the [life-cycle of a scene](scene_lifecycle.html).
277-
This will explain how scenes get started, when the stop, and how they relate to
278-
each other.
277+
This will explain how scenes get started, when they stop, and how they relate to
278+
each other.

guides/overview_styles.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Styles are optional modifiers that you can put on any primitive. Each style does a specific thing and some only affect certain primitives.
44

5-
There is a fixed list of primitives styles, which are understood by the drivers. Some Components may introduce their own optional styles, but the only ones sent down to the drivers for rendering is the list below.
5+
There is a fixed list of primitive styles which are understood by the drivers. Some Components may introduce their own optional styles, but the only ones sent down to the drivers for rendering are contained in the list below.
66

77
In general, the primitive styles are each defined in their own module, but you apply them as options in a primitive's option list.
88

@@ -34,7 +34,7 @@ The `Fill` and `Stroke` styles accept a paint type. This describes what to fill
3434

3535
There is a fixed set of paint types that the drivers know how to render.
3636

37-
* [`BoxGradient`](Scenic.Primitive.Style.Paint.BoxGradient.html) fills an primitive with a box gradient.
37+
* [`BoxGradient`](Scenic.Primitive.Style.Paint.BoxGradient.html) fills a primitive with a box gradient.
3838
* [`Color`](Scenic.Primitive.Style.Paint.Color.html) fills a primitive with a solid color.
3939
* [`Image`](Scenic.Primitive.Style.Paint.Image.html) fills a primitive with an image that is loaded into `Scenic.Cache`.
4040
* [`LinearGradient`](Scenic.Primitive.Style.Paint.LinearGradient.html) fills a primitive with a linear gradient.

guides/scene_lifecycle.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Life-cycle of a Scene
22

3-
A very important part of Scenic is the Scene life-cycle management. Most scenes' live-cycles will be managed automatically by their [ViewPort](overview_viewport.html). The ViewPort determines when to start and stop these dynamic scenes.
3+
A very important part of Scenic is the Scene life-cycle management. Most scenes' life-cycles will be managed automatically by their [ViewPort](overview_viewport.html). The ViewPort determines when to start and stop these dynamic scenes.
44

55
In effect, when you create a graph and add components like `button`, `checkbox` and more, you are doing more than just saying, "Draw a button here". You instructing the `ViewPort` how and when to start and stop the processes that drive those components.
66

0 commit comments

Comments
 (0)