Skip to content

Commit 76c31ab

Browse files
emp823mike-thompson-day8
authored andcommitted
Fix typos in the documentation
1 parent cf5e836 commit 76c31ab

17 files changed

+31
-31
lines changed

docs/Debugging.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
We recomend you use:
1+
We recommend you use:
22

33
- [re-frame-10x](https://github.com/day8/re-frame-10x) or [refrisk](https://github.com/flexsurfer/re-frisk)
44
- with [clj-devtools](https://github.com/binaryage/cljs-devtools)

docs/EPs/001-CaptureHandlerMetadata.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -177,7 +177,7 @@ XXX
177177
- XXX implications for Cursive - it currently special-cases re-frame registration function -- give ColinF a heads up??
178178
- XXX Dear God, consider changes to documentation/tutorials
179179
- XXX means giving up syntax sugar for reg-sub ?
180-
- XXX any format for `:doc` for display in HTML? Or just texual.
180+
- XXX any format for `:doc` for display in HTML? Or just textual.
181181

182182

183183

docs/EPs/004-ViewRegistration.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ What might need to be injected (as args) into a view:
2424
- other context: data from higher in the DOM tree
2525
- animation? CSS ?
2626

27-
XXX searches up the DOM heirarchy looking for a `frame` context then extracts dispatch and subscribe. Sounds inefficient.
27+
XXX searches up the DOM hierarchy looking for a `frame` context then extracts dispatch and subscribe. Sounds inefficient.
2828

2929
### Code Doodle #1
3030

@@ -95,7 +95,7 @@ Use of `:my-view-id `:
9595
:something
9696
(fn [arg1 arg2]
9797
;; obtain dispatch and subscription
98-
;; obtain a subscription ot two
98+
;; obtain a subscription or two
9999
;; add a key on the component
100100
(fn [arg1 arg2]
101101
))

docs/Effects.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -173,7 +173,7 @@ registered "effect handlers" for each.
173173
The FISA Court requires that we deny all claims
174174
that `do-fx` is secretly injected NSA surveillance-ware. <br>
175175
We also note that you've been sloppy with your personal
176-
grooming again, including, but not limited to, forgetting to clean your teeth on one occassion last week.
176+
grooming again, including, but not limited to, forgetting to clean your teeth on one occasion last week.
177177

178178
If ever you want to take control of the way effect handling is done,
179179
create your own alternative to `reg-event-fx` and, in it, inject

docs/FAQs/FocusOnElement.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Instead, you could use a more portable (but more complicated) version of this ap
3232
[:input {:ref #(reset! ref %)}])})))
3333
```
3434

35-
A terse way of achiving the same outcome is:
35+
A terse way of achieving the same outcome is:
3636
```clj
3737
[:input {:ref #(when % (.focus %)}]
3838
```

docs/Flows.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
This tutorial introduces **Flows**, part of [Domino 3](http://localhost:8000/re-frame/dominoes-30k/#domino-3-effect-handling) (effects).
88

99
!!! Note "Not to be confused with..."
10-
- [re-frame-async-flow-fx](https://github.com/day8/re-frame-async-flow-fx). A `re-frame/flow` is totally sychronous, running on every event.
10+
- [re-frame-async-flow-fx](https://github.com/day8/re-frame-async-flow-fx). A `re-frame/flow` is totally synchronous, running on every event.
1111
- The [on-changes interceptor](/re-frame/api-re-frame.core/#on-changes). Flows are an evolution of this idea.
1212
- [domino](https://github.com/domino-clj/domino). Another take on dataflow programming, inspired by re-frame.
1313

@@ -283,7 +283,7 @@ When either input changes value, our flow calls the `:output` function to recalc
283283
As before, once `:output` runs, the resulting value is stored at `:path`.
284284
So, the new value of `app-db` will contain a number at the path `[:ratios :main-rooms]`
285285

286-
Under the hood, flows relate to each other in a depedency graph.
286+
Under the hood, flows relate to each other in a dependency graph.
287287
An input like `(rf/flow<- ::kitchen-area)` creates a dependency.
288288
That means re-frame will always run `::kitchen-area` first,
289289
ensuring its output value is current before your `:main-room-ratio` flow can use it.

docs/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ docker run --rm -it -p 8000:8000 -v ${PWD}:/docs squidfunk/mkdocs-material:5.1.1
4747

4848
Then, in your browser tab, load `http://localhost:8000/`. You should see the website Home page.
4949

50-
You can now edit the markdown in `/docs` and your changes will be hot reloaded into the brower tab for inspection.
50+
You can now edit the markdown in `/docs` and your changes will be hot reloaded into the browser tab for inspection.
5151

5252

5353
## Configuration

docs/Subscribing-To-External-Data.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11

22
> This document will soon be retired, and you probably shouldn't be reading it. It may mislead you. <br> <br>
3-
> It documents an approach we experiemented with early, before realising it was probably wrong, but we haven't yet transfered the knowledge it contains to some other, less central place. So here is still sits. <br>
3+
> It documents an approach we experiemented with early, before realising it was probably wrong, but we haven't yet transferred the knowledge it contains to some other, less central place. So here is still sits. <br>
44
> <br>
55
> The RIGHT WAY in think can be found in FAQs like: <br>
66
> 1. https://day8.github.io/re-frame/FAQs/LoadOnMount/ <br>

docs/breaking-it.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ The essence of science is earnestness of inquiry.
1010

1111
> Eddington defined science as “the earnest endeavour to put into order the facts of experience”
1212
13-
So what are we doing here? Marketing (Narative warefare) for the re-frame framework or computer science.
13+
So what are we doing here? Marketing (Narrative warefare) for the re-frame framework or computer science.
1414

1515
## Pros
1616

@@ -23,7 +23,7 @@ So what are we doing here? Marketing (Narative warefare) for the re-frame frame
2323
- it leverages
2424
- pure functions
2525
- immutable data
26-
- declarative style, useing data-based DSLs
26+
- declarative style, using data-based DSLs
2727
- a shockingly effective and beautiful language (50 years of refinement by the finest minds in computer science)
2828
- React's entire ecosystem of components - although Hooks is starting to bimodalate (?word) the ecosystem.
2929
- full interop with js
@@ -58,7 +58,7 @@ As the framework author, I should be a relentless chearleader, right?. The gyrat
5858

5959
But one of the best ways for me to help you, an evaluator of this framework, is explain where and how it doesn't work well? That's this section.
6060

61-
Every design represents a point in design space, with pros and cons. The tradeoffs are the intersting bit.
61+
Every design represents a point in design space, with pros and cons. The tradeoffs are the interesting bit.
6262

6363
So I'll do that now.
6464

@@ -67,7 +67,7 @@ I will not try to contrast re-frame with your other framework options. I wish I
6767
that, but to do that well, i would need deep knowledge of all the frameworks, and I don't know of
6868
anyone who really has that. Certainly not me. I try to keep an eye on them, but by "deep knowledge"
6969
I mean you need to have used it in anger, professionally for a couple of years. Anything less and
70-
the comparisions tend to be too shallow and misleading - which means: not unsful - particularly when they
70+
the comparisons tend to be too shallow and misleading - which means: not unsful - particularly when they
7171
are written by someone with a
7272

7373

@@ -91,4 +91,4 @@ What breaks re-frame:
9191
A Framework should be invisible and boring. So, where you notice it ... that's an example of it being broken. Connection with server??
9292

9393

94-
XXX I will say that I don't think React is on the right track with hooks, Suspense. React was at its best when it tried to be the `V` in `MVC`.
94+
XXX I will say that I don't think React is on the right track with hooks, Suspense. React was at its best when it tried to be the `V` in `MVC`.

docs/clojurescript.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Clojure is a modern LISP.
2323

2424
Alan Kay once described LISP as "Maxwell's equations of software".
2525
Paul Graham believes LISP was a competitive advantage for his startup.
26-
Eric Raymmond said that learning LISP was profoundly enligthening and that knowing it would make you a better programmer for the rest of your days.
26+
Eric Raymmond said that learning LISP was profoundly enligtening and that knowing it would make you a better programmer for the rest of your days.
2727

2828
In the 70s, 80s and 90s, the LISP community went through a washing machine phase of evolutionary churn.
2929
Innovation flourished, experiments happened, prototype ideas were tested and knowledge foliated.
@@ -121,7 +121,7 @@ using Clojure's data literals and we've covered data literals.
121121

122122
You are going to be surprised and delighted with the simplicity of "evaluation".
123123

124-
**1st Evaluation Rule:** all data litterals other than `lists` and `symbols` **evaluate** to themselves.
124+
**1st Evaluation Rule:** all data literals other than `lists` and `symbols` **evaluate** to themselves.
125125

126126
| Value | Evaluates To | Comment |
127127
|---------------------|-----------------------------|-------------|
@@ -180,7 +180,7 @@ Example symbol evaluations:
180180
!!! Note "Symbols are often bound to functions"
181181

182182
For the moment, you'll have to take my word on this: the symbol `#!clj inc`
183-
is bound to a function in Clojure's standard library. As a result, when you evaulate `#!clj inc`, you get the function!! Because that's what `inc` is bound to.
183+
is bound to a function in Clojure's standard library. As a result, when you evaluate `#!clj inc`, you get the function!! Because that's what `inc` is bound to.
184184

185185
There's also another symbol, `#!clj count`, which is bound to different function in the standard library.
186186

@@ -395,7 +395,7 @@ This is a naming convention. It is used for symbols bound to predicate functions
395395
| `#!clj (empty? [:some :thing])` | `#!clj false` | |
396396

397397
Again, we can use `#!clj ?` in names because it is not
398-
an operator, as it is in other lanugages.
398+
an operator, as it is in other languages.
399399

400400
---
401401
## What Have You Learned ?
@@ -1145,7 +1145,7 @@ XXX tracking is reified dynamics. residential
11451145

11461146
We have learned:
11471147

1148-
- in ClojureScript we evaulate data, to create new data
1148+
- in ClojureScript we evaluate data, to create new data
11491149
- virtually all data literals evaluate to themselves
11501150
-
11511151

docs/data-oriented-design.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
**Data-Oriented programming happens when "data is code".** The data can be evaluated/executed.
44

5-
This data must be in a specific format - it must conform to a DSL (domain-specific language) - and there must be an interpreter for this DSL. When you feed correctly formated data into the interpreter, it is executed. "Data is code" for this interpreter.
5+
This data must be in a specific format - it must conform to a DSL (domain-specific language) - and there must be an interpreter for this DSL. When you feed correctly formatted data into the interpreter, it is executed. "Data is code" for this interpreter.
66

77
Okay, we'll cycle back to this in a minute. But first ...
88

@@ -115,7 +115,7 @@ Look carefully into re-frame, and you'll see the primacy of data everywhere.
115115
For example, with hiccup at runtime two things are happening:
116116

117117
- one execution context (ClojureScript) creates the data `(into [:div] (map renderer items))`
118-
- one execution context interpets the data (as code) - Reagent.
118+
- one execution context interprets the data (as code) - Reagent.
119119

120120
Same for string-oriented programming. One context creates the regex string (perhaps it is just a literal in that context). And the other context executes it.
121121

docs/flows-advanced-topics.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ along with the *entire* subgraph of subscription inputs:
111111
std-balloon-volume 2.5
112112
num-balloons (/ kitchen-volume std-balloon-volume)
113113
num-bags-to-buy (js/Math.ceil
114-
(/ num-baloons balloons-per-bag))]
114+
(/ num-balloons balloons-per-bag))]
115115
{:fx [[:amazon {:fn :order
116116
:sku :balloon-bag
117117
:ct num-bags-to-buy}]]})))
@@ -137,7 +137,7 @@ The fact that some view is creating and destroying them starts to seem arbitrary
137137
Subscriptions don't *need* to couple their behavior with that of their calling components.
138138

139139
The easy, automatic lifecycle behavior of subscriptions comes with a coupling of concerns. You can't directly control this lifecycle.
140-
You have to contol it by proxy, by mounting and unmounting your views. You can't *think* about your signal graph without thinking about views first.
140+
You have to control it by proxy, by mounting and unmounting your views. You can't *think* about your signal graph without thinking about views first.
141141

142142
The `app-db` represents your business state, and signals represent outcomes of your business logic. Views are just window dressing.
143143
We're tired of designing our whole business to change every time we wash the windows!

examples/simple/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Steps:
1616
2. `git clone https://github.com/day8/re-frame.git`
1717
3. `cd re-frame/examples/simple`
1818
4. Run "`npm install`" then "`npm run watch`" to compile the app and start up shadow-cljs hot-reloading
19-
5. Wait for the compile to finish. At a minumum, 15 seconds. But, if you are new to ClojureScript and some downloads are needed (caches are empty), it might take a minute or two. Eventually you should see `[:client] Build Completed (...)`
19+
5. Wait for the compile to finish. At a minimum, 15 seconds. But, if you are new to ClojureScript and some downloads are needed (caches are empty), it might take a minute or two. Eventually you should see `[:client] Build Completed (...)`
2020
6. Open `http://localhost:8280/` to see the app
2121

2222

examples/todomvc/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -29,9 +29,9 @@ really required to get the job done. So lean and minimal is no longer a goal.
2929
npm run watch
3030
```
3131

32-
5. Wait for the compile in step 4 to finish. At a minumum, 15 seconds. But, if you are new to ClojureScript and some downloads are needed (caches are empty), it might take a minute or two. Eventually you should see `[:client] Build Completed (...)`
32+
5. Wait for the compile in step 4 to finish. At a minimum, 15 seconds. But, if you are new to ClojureScript and some downloads are needed (caches are empty), it might take a minute or two. Eventually you should see `[:client] Build Completed (...)`
3333

34-
6. Wait for step 5 to do the compile, and then open in UI in the broswer:
34+
6. Wait for step 5 to do the compile, and then open in UI in the browser:
3535
```sh
3636
open http://localhost:8280
3737
```

src/re_frame/alpha.cljc

+1-1
Original file line numberDiff line numberDiff line change
@@ -532,7 +532,7 @@
532532
533533
`(handler [original-error re-frame-error])`
534534
535-
- `original-error`: A plaform-native Error object.
535+
- `original-error`: A platform-native Error object.
536536
Represents the original error thrown by user code.
537537
538538
This is the error you see when no `handler` is registered.

src/re_frame/core.cljc

+2-2
Original file line numberDiff line numberDiff line change
@@ -461,7 +461,7 @@
461461
`dynv` exists for historical reasons and is borderline deprecated these days.
462462
It is a vector of signals. Re-frame will dereference each of them and pass a
463463
vector of their values to your subscription handler as a third argument.
464-
If there's logic determing __what__ query to subscribe __to__, consider
464+
If there's logic determining __what__ query to subscribe __to__, consider
465465
expressing it in a `signal function`, or use `reg-sub-raw`. Failing that, `dynv`
466466
allows you to colocate this logic with the `subscribe` call.
467467
@@ -690,7 +690,7 @@
690690
691691
`(handler [original-error re-frame-error])`
692692
693-
- `original-error`: A plaform-native Error object.
693+
- `original-error`: A platform-native Error object.
694694
Represents the original error thrown by user code.
695695
this is the error you see when no `handler` is registered.
696696

src/re_frame/interceptor.cljc

+1-1
Original file line numberDiff line numberDiff line change
@@ -170,7 +170,7 @@
170170
(let [{:keys [event-v direction interceptor]} (ex-data re-frame-error)
171171
event-handler? (#{:db-handler :fx-handler :ctx-handler} interceptor)]
172172
(apply console :error
173-
"An error occured while handling the re-frame event:"
173+
"An error occurred while handling the re-frame event:"
174174
(str event-v)
175175
"\n"
176176
(map str

0 commit comments

Comments
 (0)