Merge branch 'minor_punctuation' of https://github.com/mpantel/hyperstack into mpantel-minor_punctuation

catmando · catmando · commit cbedc33e42a9 · 2021-03-31T14:35:03.000-04:00
diff --git a/docs/client-dsl/component-basics.md b/docs/client-dsl/component-basics.md
@@ -38,7 +38,7 @@ end
 
 To create a component instance, you reference its class name as a method call from another component. This creates a new instance, passes any parameters and proceeds with the component lifecycle.
 
-> **[The actual type created is an Element read on for details...](notes.md#component-instances)**
+> **[The actual type created is an Element, read on for details...](notes.md#component-instances)**
 
 ```ruby
 class FirstComponent < HyperComponent
diff --git a/docs/client-dsl/events-and-callbacks.md b/docs/client-dsl/events-and-callbacks.md
@@ -145,7 +145,7 @@ Besides the UI there are several other sources of events:
 + Web Workers
 
 The way you receive events from these sources depends on the event.  Typically though the method will either take a block, or callback proc, or in many cases will return a Promise.
-Regardless the event handler will do one of three things:  mutate some state within the component, fire an event to a higher level component, or update some shared store.
+Regardless, the event handler will do one of three things:  mutate some state within the component, fire an event to a higher level component, or update some shared store.
 
 > For details on updating shared stores, which is often the best answer **[see the chapter on HyperState...](../hyper-state/README.md)**
 
diff --git a/docs/client-dsl/lifecycle-methods.md b/docs/client-dsl/lifecycle-methods.md
@@ -36,7 +36,8 @@ Except for `render`, multiple lifecycle callbacks may be defined for each lifecy
 The lifecycle revolves around rendering the component. As the state or parameters of a component change, its render callback will be executed to generate the new HTML.
 
 ```ruby
-render do ....
+render do 
+  ...
 end
 ```
 
@@ -61,7 +62,8 @@ end
 ### Before Mounting \(first render\)
 
 ```ruby
-before_mount do ...
+before_mount do 
+  ...
 end
 ```
 
@@ -72,7 +74,8 @@ This is the only life cycle callback run during `render_to_string` used in serve
 ### After Mounting \(first render\)
 
 ```ruby
-after_mount do ...
+after_mount do 
+  ...
 end
 ```
 
@@ -83,7 +86,8 @@ If you want to integrate with other JavaScript frameworks, set timers using the
 ### Before Receiving New Params
 
 ```ruby
-before_new_params do |new_params_hash| ...
+before_new_params do |new_params_hash| 
+  ...
 end
 ```
 
@@ -102,7 +106,8 @@ end
 ### Before Updating \(re-rendering\)
 
 ```ruby
-before_update do ...
+before_update do 
+  ...
 end
 ```
 
@@ -111,7 +116,8 @@ Invoked immediately before rendering when new params or state are being received
 ### After Updating \(re-rendering\)
 
 ```ruby
-after_update do ...
+after_update do 
+  ...
 end
 ```
 
@@ -122,7 +128,8 @@ Use this as an opportunity to operate on the DOM when the component has been upd
 ### Unmounting
 
 ```ruby
-before_unmount do ...
+before_unmount do 
+  ...
 end
 ```
 
diff --git a/docs/client-dsl/notes.md b/docs/client-dsl/notes.md
@@ -4,7 +4,7 @@
 
 Ruby methods may *receive* a block which is simply an anonymous function.  
 
-The following code in Ruby
+The following code in Ruby:
 
 ```ruby
 some_method(1, 2, 3) { |x| puts x }
@@ -13,7 +13,7 @@ is roughly equivilent to this Javascript
 ```JavaScript
 some_method(1, 2, 3 function(x) { console.log(x) })
 ```
-In Ruby blocks may be specified either using `do ... end` or with `{ ... }`
+In Ruby blocks may be specified either using `do ... end` or with `{ ... }`:
 
 ```Ruby
 some_method { an_expression }
@@ -23,7 +23,7 @@ some_method do
   expressions
 end
 ```
-Standard style reserves the `{ ... }` notation for single line blocks, and `do ... end` for multiple line blocks
+Standard style reserves the `{ ... }` notation for single line blocks, and `do ... end` for multiple line blocks.
 
 ### Component Instances
 
@@ -140,6 +140,7 @@ default to the one provided by Hyperstack.
 ### Proper Use Of Keys
 
 > For best results the `key` is supplied at highest level possible.  (NOTE THIS MAY NO LONGER BE AN ISSUE IN LATEST REACT)  
+
 ```ruby
 # WRONG!
 class ListItemWrapper < HyperComponent
@@ -160,6 +161,7 @@ class MyComponent < HyperComponent
   end
 end
 ```
+
 ```ruby
 # CORRECT
 class ListItemWrapper < HyperComponent
diff --git a/docs/client-dsl/params.md b/docs/client-dsl/params.md
@@ -9,7 +9,7 @@ The param declaration has several options providing a default value, expected ty
 Examples:
 
 ```ruby
-param :foo # declares that we must be provided with a parameter foo when the component is instantiated or re-rerendered.
+param :foo # declares that we must provide a parameter foo when the component is instantiated or re-rerendered.
 param :foo => "some default"        # declares that foo is optional, and if not present the value "some default" will be used.
 param foo: "some default"           # same as above using ruby 1.9 JSON style syntax
 param :foo, default: "some default" # same as above but uses explicit default key
diff --git a/docs/rails-installation/other-details.md b/docs/rails-installation/other-details.md
@@ -32,7 +32,7 @@ using webpacker its actually not necessary (but doesn't hurt anything.)
 
 #### The application layout
 
-If using a recent version of rails with webpacker you may find that the application.html.erb file longer loads the application.js file.  Make sure that your layout file has this line:
+If using a recent version of rails with webpacker you may find that the application.html.erb file no longer loads the application.js file.  Make sure that your layout file has this line:
 
 ```html
    <%= javascript_include_tag 'application' %>
