Skip to content

Commit c66535d

Browse files
committed
Fix more spellings
1 parent 117fec7 commit c66535d

18 files changed

+64
-54
lines changed

.spelling

+16-6
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
# Don't add code words here, surround them in code blocks (`) instead
22

33
404s
4+
31-bit
5+
32-bit
46
63-bit
57
64-bit
68
API
@@ -13,7 +15,6 @@ Asana
1315
Auth0
1416
Biggar
1517
Booleans
16-
Bucklescript
1718
CCPA
1819
CDN
1920
CLA
@@ -26,7 +27,6 @@ Clojure
2627
Cloudflare
2728
Cmd
2829
CoffeeScript
29-
Cohttp
3030
Cron
3131
Crons
3232
Ctrl
@@ -48,27 +48,28 @@ HIPAA
4848
HTTP3
4949
Haskell
5050
Honeycomb
51-
HttpClient
5251
IFTTT
5352
ImageMagick
5453
JS
5554
JSON
5655
Javascript
56+
Kubernetes
5757
LOC
5858
MDN
5959
MacOS
6060
Mailchimp
61-
Mono
6261
Netlify
6362
Nginx
6463
NodeJS
64+
NuGet
6565
OAuth
6666
OCaml
6767
OSX
6868
Onboarding
6969
Overwatch
7070
PHP
7171
PII
72+
Paket
7273
PokeAPI
7374
Pokemon
7475
Postgres
@@ -79,6 +80,8 @@ README
7980
REPL
8081
REPLs
8182
RSA
83+
DSA
84+
ECDSA
8285
React
8386
Read-Eval-Print
8487
ReasonML
@@ -98,15 +101,19 @@ TestCafe
98101
Toplevels
99102
Trello
100103
Twilio
104+
UCS-2
101105
UDP
102106
UI
103107
URI
104108
USERNAME-CANVASNAME
109+
UTF-16
105110
UTF-8
106-
UTF8
107111
UUID
108112
UUIDs
113+
VSCode
109114
Vue
115+
WASM
116+
WebAssembly
110117
XMLHttpRequest
111118
ad-hoc
112119
allowlist
@@ -146,6 +153,7 @@ deserializers
146153
destructure
147154
destructuring
148155
dev
156+
devcontainer
149157
dicts
150158
docstring
151159
docstrings
@@ -174,6 +182,7 @@ localhost
174182
macOS
175183
manager-ish
176184
meetups
185+
metadata
177186
middleware
178187
minimap
179188
monorepo
@@ -182,6 +191,7 @@ natively
182191
omnibox
183192
param
184193
params
194+
pipeable
185195
pipelining
186196
popups
187197
pre-define
@@ -195,7 +205,6 @@ reformats
195205
renamings
196206
repo
197207
repos
198-
restdb.io
199208
rollout
200209
runtime
201210
serializer
@@ -212,6 +221,7 @@ substrings
212221
syntaxes
213222
timelines
214223
timestamp
224+
tokenized
215225
tooltip
216226
tooltips
217227
toplevel

README.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Dark Documentation
22

3-
Welcome to the source for the [Dark](https://darklang.com) documentation. Contribute
4-
your improvements as a pull request, or report problems in an issue.
3+
Welcome to the source for the [Dark](https://darklang.com) documentation.
4+
Contribute your improvements as a pull request, or report problems in an issue.
55

66
View the live docs here: [https://darklang.com/docs](https://darklang.com/docs)
77

@@ -254,14 +254,14 @@ common errors. If you run `npm run format` you should pass the linter.
254254

255255
The `.circleci/config.yml` file describes the CircleCI configuration. It watches
256256
for commits/merges into the `main` branch, runs a script to generate the
257-
contents of `gh-pages`, and pushes `gh-pages` to github.
257+
contents of `gh-pages`, and pushes `gh-pages` to GitHub.
258258

259259
## Publishing Changes Manually
260260

261261
**NOTE: You shouldn't need to do this because CircleCI runs this
262262
automatically.**
263263

264-
On the commandline (remember to replace `<YOUR USERNAME>` with your github
264+
On the commandline (remember to replace `<YOUR USERNAME>` with your GitHub
265265
username):
266266

267267
```sh

docs/changelog/release-1.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -940,10 +940,10 @@ We added a bunch of improved documentation, including:
940940

941941
![changelog/image2.gif](/img/changelog/image2.gif)
942942

943-
- We asked y'all to not make HttpClient calls to your Dark canvas from REPLs.
943+
- We asked y'all to not make `HttpClient` calls to your Dark canvas from REPLs.
944944
We've made some infrastructural changes that fix the issue on our end, so you
945945
should feel free to do that now. This is useful if you want to create a HTTP
946-
trace without leaving Dark. (Note: please don't make HttpClient calls **_to
946+
trace without leaving Dark. (Note: please don't make `HttpClient` calls **_to
947947
Dark_** from HTTP handlers)
948948

949949
## Week of 1/10/2020

docs/changelog/release-2.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,7 @@ users.
132132
response of status code 418. It now processes the request instead.
133133

134134
- `HttpClient::*` functions called with usernames and passwords in the URL can
135-
now support arbitrary UTF8 (in the past, Unicode was not supported.)
135+
now support arbitrary UTF-8 (in the past, Unicode was not supported.)
136136

137137
- `X509::pemCertificatePublicKeys` used to only work for RSA keys. It now also
138138
supports DSA and ECDSA keys. The old version would read ECDSA keys and return
@@ -149,7 +149,7 @@ users.
149149

150150
These breaking changes were documented and announced many months in advance of
151151
switching over to the new version of Darklang. We also very careful deployed the
152-
new code, watching for suspiscious changes in any Dark programs that were
152+
new code, watching for suspicious changes in any Dark programs that were
153153
running. In the rare case where something went awry, we contacted the users and
154154
worked with them to ensure a seamless transition.
155155

@@ -199,7 +199,7 @@ bare identifiers, while the new version puts them in a string (e.g. `NaN` vs
199199
This may occur in any of the places in which we generate JSON, which are:
200200

201201
- when responding to a HTTP request in the HTTP framework
202-
- when making a request with HttpClient (any version)
202+
- when making a request with `HttpClient` (any version)
203203
- when calling any of:
204204
- `Dict::toJson_v0`
205205
- `Object::toJson_v1` (_deprecated_)
@@ -232,7 +232,7 @@ before).
232232
Dark parses JSON:
233233

234234
- when receiving a HTTP request in the HTTP framework
235-
- when receiving a response to a request made with HttpClient (any version)
235+
- when receiving a response to a request made with `HttpClient` (any version)
236236
- when calling any of:
237237

238238
- `JSON::parse_v1`
@@ -314,14 +314,14 @@ Behind the scenes, Dark has greatly improved its operations.
314314

315315
- Nodes are now autoscaled, leading to significant cost savings.
316316

317-
- Updated to latest version of kubernetes, cert-manager (which powers our
317+
- Updated to latest version of Kubernetes, `cert-manager` (which powers our
318318
[custom domains](https://docs.darklang.com/how-to/custom-domains) feature),
319319
nginx, and other tools that we use.
320320

321321
- Added internal [feature flagging](https://launchdarkly.com) to give us more
322322
control over how our infrastructure runs in production
323323

324-
- Significantly increased use of kubernetes' security features, in particular
324+
- Significantly increased use of Kubernetes' security features, in particular
325325
internal firewalls.
326326

327327
- Standardized our production deployment process using a tool we wrote called
@@ -338,8 +338,8 @@ Behind the scenes, Dark has greatly improved its operations.
338338

339339
- moved docs to docs.darklang.com
340340
- [refactored docs](https://github.com/darklang/docs/pull/220) to use the Divio
341-
documentation system, categorizing all docs into Tuotials, Reference, How-tos,
342-
Walk-throughs and Discussion.
341+
documentation system, categorizing all docs into Tutorials, Reference,
342+
How-tos, Walk-throughs and Discussion.
343343
- fixed all links
344344
- redo the
345345
[Error Rail discussion](https://docs.darklang.com/discussion/error-handling)
@@ -357,7 +357,7 @@ Behind the scenes, Dark has greatly improved its operations.
357357
throughout the [darklang repo](https://github.com/darklang/dark)
358358

359359
- Moved 99% of project collaboration to our
360-
[public github](https://github.com/darklang/dark) and
360+
[public GitHub](https://github.com/darklang/dark) and
361361
[public community chat](https://darklang.com/discord-invite)
362362

363363
- ported our

docs/changelog/release-3.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ old features.
1414
source of annoyance for devs trying to figure out why their code wasn't
1515
working.
1616

17-
- 64bit ints now work end-to-end (previously we had two separate issues with
17+
- 64-bit ints now work end-to-end (previously we had two separate issues with
1818
numbers above `2^53` and numbers above `2^63`)
1919
([#4209](https://github.com/darklang/dark/pull/4209))
2020

docs/changelog/release-4.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ August 1, 2022
3434
([#4294](https://github.com/darklang/dark/pull/4294)).
3535

3636
- Tuples are not ready ready to release, but much of the behind the scenes work
37-
is done, including adding standard library fuctions
37+
is done, including adding standard library functions
3838
([#4311](https://github.com/darklang/dark/pull/4311)).
3939

4040
- We are working to expose more useful information in the editor, especially

docs/changelog/release-5.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -74,9 +74,9 @@ Finally, in-progress features can now be enabled for devs, starting with Tuples
7474
[#4420](https://github.com/darklang/dark/pull/4420),
7575
[#4426](https://github.com/darklang/dark/pull/4426))
7676

77-
## In-progress features - HttpClient and HTTP framework
77+
## In-progress features - `HttpClient` and HTTP framework
7878

79-
The current HttpClient and HTTP framework are quite limited, only supporting
79+
The current `HttpClient` and HTTP framework are quite limited, only supporting
8080
text request/response bodies, among many other problems. They also lack the
8181
flexibility to control and compose their behavior.
8282

docs/changelog/release-6.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -131,10 +131,10 @@ _Tuples are in preview - enable them in **Settings/Contributor Settings**_
131131
- When a handler's route changes, update "open-in-new-window" to use the new
132132
route ([#4502](https://github.com/darklang/dark/pull/4502))
133133

134-
- dont insert `0` when copy/pasting from the start of ints in patterns
134+
- don't insert `0` when copy/pasting from the start of ints in patterns
135135
([#4492](https://github.com/darklang/dark/pull/4492))
136136

137-
- Dont create empty patterns when creating match
137+
- Don't create empty patterns when creating match
138138
([#4469](https://github.com/darklang/dark/pull/4469))
139139

140140
- put the cursor in right place after a string edit

docs/contributing/adding-your-first-test.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ for a built-in function. This will get you through the process of contributing
77
and get you familiar with how to get code into Dark.
88

99
_We're assuming you've got the repo is set up and the `builder` script is
10-
running (or if you're running the devcontainer in VSCode, that the decvontainer
10+
running (or if you're running the devcontainer in VSCode, that the devcontainer
1111
is running)!_
1212

1313
## Adding the test

docs/contributing/repo-layout.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ here's how the various directories intersect, and what language they use:
1010
## Directory listing
1111

1212
- `.circleci` - CI config file
13-
- `.ionide` - config for F# VsCode plugin
14-
- `.vscode` - VsCode config
13+
- `.ionide` - config for F# VSCode plugin
14+
- `.vscode` - VSCode config
1515
- `auth0-branding` - has some assets for our login provider
1616
- `client` - the editor, and the entire frontend application that is found under
1717
[darklang.com/a/yourcanvas](http://darklang.com/a/yourcanvas) (note, not
@@ -50,13 +50,13 @@ here's how the various directories intersect, and what language they use:
5050
- `backend` - The backend written in F# and .NET. including the language
5151
definition and execution engine, the "framework" (HTTP, DB, queues, etc), the
5252
editor's HTTP API, and the execution engine which runs in the client.
53-
- `.paket` - Used by the paket/nuget package manager
53+
- `.paket` - Used by the Paket/NuGet package manager
5454
- `Build` - where the compiler puts compiled code
55-
- `paket-files` - Used by the paket/nuget package manager
55+
- `paket-files` - Used by the Paket/NuGet package manager
5656
- `src/ApiServer` - webserver serving the editor and the API used by the
5757
editor
58-
- `src/BackendOnlyStdLib` - impl. of functions which need to be run on the
59-
backend, due to their connection to the DB, queues, etc.
58+
- `src/BackendOnlyStdLib` - implementation of functions which need to be run
59+
on the backend, due to their connection to the DB, queues, etc.
6060
- `src/Benchmark` - a benchmark executable to measure the performance of Dark
6161
code
6262
- `src/BwdServer` - webserver that is grand-user facing (at builtwithdark.com)

docs/contributing/rescript-and-fsharp-for-dark-developers.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,7 @@ libraries from `.NET`, FSharp.Core, or if necessary, the FSharpPlus library.
124124
### Int
125125

126126
An `int` is the same in Dark and F#, same syntax, same meaning. Note that ints
127-
are 31 bits in ReScript, 32 bits in F#, and 64bit in Dark.
127+
are 31-bit in ReScript, 32-bit in F#, and 64-bit in Dark.
128128

129129
```fsharp
130130
let x = 5
@@ -442,7 +442,7 @@ type t =
442442

443443
Type `t` (it's a common convention to name the main type of a module `t`) must
444444
be one of `EInteger`, `EBool`, `EString`, etc. `EInteger` takes two parameters,
445-
an `id` and a `string` (we use a string to represent integers as Bucklescript
445+
an `id` and a `string` (we use a string to represent integers as ReScript
446446
doesn't have a big enough integer type).
447447

448448
To create a `t`, you'd do something like this:
@@ -477,7 +477,7 @@ list->List.map((elem) => elem + 2)
477477

478478
It's very common to use functions like `List.map` which have a parameter called
479479
`f` which take a lambda. In F#, above, that parameter is passed like any other.
480-
In ReScript, those parameters are passed as labelled variables:
480+
In ReScript, those parameters are passed as labeled variables:
481481

482482
```rescript
483483
list->List.map:(~f=((elem) => elem + 2))
@@ -563,7 +563,7 @@ print(myString)
563563
For functions that perform IO, you'll need to use the `ply` or `task`
564564
"computation expression". A "computation expression" is a special F# language
565565
feature for writing abstractions with a nice syntax. The `ply` CE allows using a
566-
specialized asyncronous structure called Ply (which is extremely similar to a
566+
specialized asynchronous structure called Ply (which is extremely similar to a
567567
.Net Task) easily, and can best be illustrated with an example:
568568

569569
```fsharp
@@ -589,10 +589,10 @@ Let's break this down line by line:
589589
`Ply`, in this case a `Ply<Dval>`.
590590

591591
Why do we go through all this trouble? Because this is an async runtime, and
592-
`let!` and `return` are the enablers of the asyncronicity. A `Ply` is a promise,
593-
and `let!` waits for the promise and then continues (running other code while
594-
the IO is still pending). This is the exact same as the `async` keyword in JS,
595-
Rust, C# or Python.
592+
`let!` and `return` are the enablers of the asynchronicity. A `Ply` is a
593+
promise, and `let!` waits for the promise and then continues (running other code
594+
while the IO is still pending). This is the exact same as the `async` keyword in
595+
JS, Rust, C# or Python.
596596

597597
Note that while we primarily use `Ply` and `uply` inside the Interpreter, most
598598
of our other async code use `Task` and `task`. These are interchangeable except

docs/contributing/tour-of-editor.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ The editor is in `client/`. We refer to it as the client or the editor (we don't
66
call it the frontend though).
77

88
It started life as an Elm application, and still uses the Elm Architecture
9-
(which we like). The current app is in Bucklescript.
9+
(which we like). The current app is in ReScript.
1010

1111
## Elm architecture
1212

docs/contributing/troubleshooting.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ If you're having problems contributing, we want to help:
1313
Common fixes:
1414

1515
- Sometimes there are compilation problems where the build caches from various
16-
package managers we use (npm, nuget) develop problems. They can be fixed by
16+
package managers we use (NPM, NuGet) develop problems. They can be fixed by
1717
clearing the build directories (which are in Docker volumes) by running the
1818
related scripts:
1919
- for client errors, use `./scripts/clear-bs-cache` and

0 commit comments

Comments
 (0)