Skip to content

Commit

Permalink
typo fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
g-harel committed Apr 17, 2019
1 parent 22b20d1 commit aa406dc
Show file tree
Hide file tree
Showing 9 changed files with 22 additions and 22 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ npm run aws-deploy

By default, this command will build and upload all files from the `/dist` directory except ones in `/dist/res`. Note that this will override the files in the s3 bucket.

To include changes to the resouces folder in the deployment:
To include changes to the resources folder in the deployment:

```
npm run aws-deploy -- --includeResources
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
"webpack": "^3.11.0"
},
"dependencies": {
"okwolo": "^3.3.1"
"okwolo": "^3.4.0"
},
"postcss": {
"plugins": {
Expand Down
6 changes: 3 additions & 3 deletions src/pages/api/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -160,14 +160,14 @@ module.exports = () => () => (
[Example, {}, [
[Codeblock, {}, [`
app.setState({
friendlist: [],
friends: [],
});
app.use('action', {
type: 'ADD_FRIEND',
target: [],
handler: (state, newFriend) => {
state.friendlist.push(newFriend);
state.friends.push(newFriend);
return state;
},
});
Expand Down Expand Up @@ -350,7 +350,7 @@ module.exports = () => () => (
]);
const plugin = {
name: 'my-middlware-plugin',
name: 'my-middleware-plugin',
middleware: (next, state, actionType, params) => {
if (state.items.length === 0) {
params.empty = true;
Expand Down
10 changes: 5 additions & 5 deletions src/pages/blobs/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@ module.exports = () => () => (
'draw',
]],
['p.copy', {}, [
'The draw function handles the inital drawing to a new target. It should return a view object that will be given to the update function. The format of this object is not enforced. Note that the view module does not verify the type of the target and it is therefore good practice to make these checks before intracting with the target.',
'The draw function handles the initial drawing to a new target. It should return a view object that will be given to the update function. The format of this object is not enforced. Note that the view module does not verify the type of the target and it is therefore good practice to make these checks before interacting with the target.',
]],
[Codeblock, {}, [`
app.use('draw', (target, vdom) => {
Expand Down Expand Up @@ -207,7 +207,7 @@ module.exports = () => () => (
]],
['div.section', {}, [
['h2.title', {}, [
'udpate',
'update',
]],
['p.copy', {}, [
'The update function updates the target with new vdom. It also receives the update address and the view object from a draw or a previous render as third and fourth arguments respectively. However, there is no defined format for either of these values and they can be omitted if not necessary.',
Expand All @@ -232,7 +232,7 @@ module.exports = () => () => (
'watcher',
]],
['p.copy', {}, [
'Watchers are funtctions that get called after all state changes. They cannot modify the state directly since they are given a copy, but they can safely issue more actions.',
'Watchers are functions that get called after all state changes. They cannot modify the state directly since they are given a copy, but they can safely issue more actions.',
]],
[Codeblock, {}, [`
app.use('watcher', (state, actionType, params) => {
Expand All @@ -248,7 +248,7 @@ module.exports = () => () => (
'plugins',
]],
['p.copy', {}, [
'To accomodate the addition of plugins, the use function can also accept an object as the first argument. This object can contain multiple types of blobs.',
'To accommodate the addition of plugins, the use function can also accept an object as the first argument. This object can contain multiple types of blobs.',
]],
[Codeblock, {}, [`
app.use({
Expand All @@ -262,7 +262,7 @@ module.exports = () => () => (
[Codeblock, {}, [`
let myPlugin = {
name: 'myPluginName',
middleware: myMiddlware,
middleware: myMiddleware,
}
app.use(myPlugin);
Expand Down
8 changes: 4 additions & 4 deletions src/pages/home/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,11 @@ const tiles = [
},
{
title: 'modules',
copy: 'Modules are very similar in purpose and capabilities to blobs, but they differ in the sense that they have already been consumed by the app at creation time. This also alows them to have privileged access to the app\'s "official" global object.',
copy: 'Modules are very similar in purpose and capabilities to blobs, but they differ in the sense that they have already been consumed by the app at creation time. This also allows them to have privileged access to the app\'s "official" global object.',
},
{
title: 'kits',
copy: 'Kits represent preconfigured app bundles. These bundles are built from a group of modules and can be customized infinitely to add or remove features to the produced app as a project demands it. Okwolo currently ships with three different kits which share many modules, but behave very differently.',
copy: 'Kits represent pre-configured app bundles. These bundles are built from a group of modules and can be customized infinitely to add or remove features to the produced app as a project demands it. Okwolo currently ships with three different kits which share many modules, but behave very differently.',
},
];

Expand Down Expand Up @@ -125,7 +125,7 @@ module.exports = () => () => (
'Okwolo is meant to be used and distributed in kits, each with their own unique flavor and purpose. Although there are currently only three officially supported kits, the modules they are built from are can be reused and replaced easily.',
]],
['p.copy', {}, [
'Okwolo\'s kits/modules are designed to support asynchronous configuration. This means that an instanciated app\'s config can be modified at any time without needing to be restarted. An example use case of this property would be to progressively load a web app\'s routes/actions while a user is navigating a page.',
'Okwolo\'s kits/modules are designed to support asynchronous configuration. This means that an instantiated app\'s config can be modified at any time without needing to be restarted. An example use case of this property would be to progressively load a web app\'s routes/actions while a user is navigating a page.',
]],
['p.copy', {}, [
'Each module also contains a lot of error catching code to fail as fast as possible when a problem occurs, and to provide clear and useful feedback. This means errors should always have added context. If you find an error that is not handled, please ',
Expand All @@ -136,7 +136,7 @@ module.exports = () => () => (
'The two client side kits "standard" and "lite" come ready with a built-in client-side router. The "standard" kit also includes more advanced state management which takes inspiration from the redux pattern.',
]],
['p.copy', {}, [
'The view portion of okowlo is uses a vdom implementation which runs keyed diffs to update layout. It also allows for scoped updates of this layout to update individual components. For more details about components, visit the ',
'The view portion of okowlo uses a vdom implementation which runs keyed diffs to update layout. It also allows for scoped updates of this layout to update individual components. For more details about components, visit the ',
[Link, {path: '/syntax/'}, ['syntax page']],
'.',
]],
Expand Down
4 changes: 2 additions & 2 deletions src/pages/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -20,13 +20,13 @@ module.exports = [
{
pathname: '/modules/',
title: 'Modules - okwolo',
description: 'Modules are very similar in purpose and capabilities to blobs, but they differ in the sense that they have already been consumed by the app at creation time. This also alows them to have privileged access to the app\'s "official" global object.',
description: 'Modules are very similar in purpose and capabilities to blobs, but they differ in the sense that they have already been consumed by the app at creation time. This also allows them to have privileged access to the app\'s "official" global object.',
component: require('../pages/modules'),
},
{
pathname: '/kits/',
title: 'Kits - okwolo',
description: 'Kits represent preconfigured app bundles. These bundles are built from a group of modules and can be customized infinitely to add or remove features to the produced app as a project demands it. Okwolo currently ships with three different kits which share many modules, but behave very differently.',
description: 'Kits represent pre-configured app bundles. These bundles are built from a group of modules and can be customized infinitely to add or remove features to the produced app as a project demands it. Okwolo currently ships with three different kits which share many modules, but behave very differently.',
component: require('../pages/kits'),
},
{
Expand Down
2 changes: 1 addition & 1 deletion src/pages/kits/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ module.exports = () => () => (
const okwolo = require('okwolo/server');
`]],
['p.copy', {}, [
'The server kit is meant to be used as a server-side rendering tool. Since it is only concerned with producing html from state, there is no need for the router module or the elabotate state handling. It\'s larger size is due to the built-in character escaping library which sanitizes rendered text nodes.',
'The server kit is meant to be used as a server-side rendering tool. Since it is only concerned with producing html from state, there is no need for the router module or the elaborate state handling. It\'s larger size is due to the built-in character escaping library which sanitizes rendered text nodes.',
]],
['p.copy', {}, [
'The following example shows the minimal setup.',
Expand Down
8 changes: 4 additions & 4 deletions src/pages/modules/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ const Link = require('../../components/link');

const name = 'modules';
const icon = '/res/icons/kits.svg';
const copy = 'Modules are very similar in purpose and capabilities to blobs, but they differ in the sense that they have already been consumed by the app at creation time. This also alows them to have privileged access to the app\'s "official" global object.';
const copy = 'Modules are very similar in purpose and capabilities to blobs, but they differ in the sense that they have already been consumed by the app at creation time. This also allows them to have privileged access to the app\'s "official" global object.';
const menu = [
null,
'state',
Expand Down Expand Up @@ -129,7 +129,7 @@ module.exports = () => () => (
}
`]],
['p.copy', {}, [
'This pattern of callbacks establishes a two-way communication channel between the state module and the optionnal handler while remaining optional for kits that do not need more state logic.',
'This pattern of callbacks establishes a two-way communication channel between the state module and the optional handler while remaining optional for kits that do not need more state logic.',
]],
['p.copy', {}, [
'The following snippet shows the different ways to interact with the "state.handler" module used in the standard kit.',
Expand Down Expand Up @@ -196,7 +196,7 @@ module.exports = () => () => (
},
})();
app.use('base', '/acmeapp');
app.use('base', '/acme');
app.redirect('/home');
Expand Down Expand Up @@ -268,7 +268,7 @@ module.exports = () => () => (
'. The module allows any of these blobs to change at any time and provides clear feedback if something is missing or invalid.',
]],
['p.copy', {}, [
'The view module keeps track of two variables. The first one is a copy of the state. This copy is updated each time the state changes (by listening for the "state" event) and is used to rerender layout when one of the view blobs change. The second variable is the arbitrary layout data returned by both the draw and update blobs. This data is also passed to the update blob and can therefore be used to store any information about the view (ex. vdom).',
'The view module keeps track of two variables. The first one is a copy of the state. This copy is updated each time the state changes (by listening for the "state" event) and is used to re-render layout when one of the view blobs change. The second variable is the arbitrary layout data returned by both the draw and update blobs. This data is also passed to the update blob and can therefore be used to store any information about the view (ex. vdom).',
]],
['p.copy', {}, [
'The view module also changes the app\'s primary function to make it update the builder func.',
Expand Down
2 changes: 1 addition & 1 deletion src/pages/syntax/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,7 @@ module.exports = () => () => (
'The model of having a function X which returns a function Y which returns an element is very convenient. The first benefit is that function X will only be called once (unless a parent up the chain gets updated). This makes it the perfect place to parse props and provide clean data for the Y function to render from. Since variables declared in X are in the Y function\'s scope, they can be treated as the component\'s state and used accordingly. As shown in the above example, functions can also be declared within this scope to provide utilities to modify "state" and then update the layout when they complete.',
]],
['p.copy', {}, [
'The update function should generally not be "leaked" out of the component. If it is called after the component has been replaced, okwolo will throw an error. Calling update will add that task to a queue to be executed in the same order they are added. This means calling update within the X function (as defined in the earlier paragraph) will not preemtp the initial draw and it\'s result will be correctly displayed. It also means it is safe to call update within itself as long as the recursion avoids maxing out the stack.',
'The update function should generally not be "leaked" out of the component. If it is called after the component has been replaced, okwolo will throw an error. Calling update will add that task to a queue to be executed in the same order they are added. This means calling update within the X function (as defined in the earlier paragraph) will not preempt the initial draw and it\'s result will be correctly displayed. It also means it is safe to call update within itself as long as the recursion avoids maxing out the stack.',
]],
]],
]]
Expand Down

0 comments on commit aa406dc

Please sign in to comment.