Skip to content

Commit 4c2a935

Browse files
authored
docs: fix various typos in documentation and comments (#2424)
1 parent 017217d commit 4c2a935

File tree

27 files changed

+35
-35
lines changed

27 files changed

+35
-35
lines changed

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ This is the main repo of the Wasp universe, containing core code (mostly `waspc`
103103

104104
# Project status
105105

106-
Currently, Wasp is in beta, with most features flushed out and working well.
106+
Currently, Wasp is in beta, with most features fleshed out and working well.
107107
However, there are still a lot of improvements and additions that we have in mind for the future, and we are working on them constantly, so you can expect a lot of changes and improvements in the future.
108108

109109
While the idea is to support multiple web tech stacks in the future, right now, we are focusing on the specific stack: React + react-query, NodeJS + ExpressJS, and Prisma.

waspc/ChangeLog.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ You can now write this:
5858

5959
```typescript
6060

61-
improt { App } from 'wasp-config'
61+
import { App } from 'wasp-config'
6262

6363
const app = new App('TodoApp', {
6464
wasp: {
@@ -1621,7 +1621,7 @@ Make sure to update your Wasp VSCode extension to get the benefits of Wasp Langu
16211621
### [NEW FEATURE] Optimistic updates via useAction hook
16221622
16231623
We added `useAction` hook to our JS API, which allows you to specify optimistic update details for an Action.
1624-
This means that, if you have a good idea of how an Action will affect the state on the client, you can perform those changes immediatelly upon its call (instead of waiting for Action to finish), by modifying what specific Queries currently return.
1624+
This means that, if you have a good idea of how an Action will affect the state on the client, you can perform those changes immediately upon its call (instead of waiting for Action to finish), by modifying what specific Queries currently return.
16251625
Once Action is actually done, related Queries will be unvalidated as usual and therefore fetch the real result, but in the meantime the changes you specified via optimistic updates will be visible.
16261626
16271627
This is great for apps where there is a lot of interactivity and you want the UI to update instantly with your changes, even as they are still being saved to the server.
@@ -1648,7 +1648,7 @@ Check out https://wasp-lang.dev/docs/language/features#the-useaction-hook for mo
16481648
16491649
### Upgraded Prisma to latest version (13.15.2)
16501650
1651-
Among various other things, this brins support for OpenSSL3. So if you couldn't run Wasp on your operating system due to Prisma not supporting OpenSSL3, those days are over!
1651+
Among various other things, this brings support for OpenSSL3. So if you couldn't run Wasp on your operating system due to Prisma not supporting OpenSSL3, those days are over!
16521652
16531653
---
16541654
@@ -1682,8 +1682,8 @@ To run Jobs, you don't need any additional infrastructure at the moment, just a
16821682
### BREAKING CHANGES
16831683
16841684
- Wasp now requires latest LTS version of NodeJS
1685-
- We had a bit of issues with being too relaxed on the version of NodeJS that can be used with Wasp so we thightened it up a bit.
1686-
We also added a more thorough check in Wasp for it, that will warn you very explicitely if you are using the wrong version of Node.
1685+
- We had a bit of issues with being too relaxed on the version of NodeJS that can be used with Wasp so we tightened it up a bit.
1686+
We also added a more thorough check in Wasp for it, that will warn you very explicitly if you are using the wrong version of Node.
16871687
- Updated react-query to v3
16881688
- This brings some new features from react query while also laying the foundation for the further features we are building on top of it in Wasp (coming soon!).
16891689
- Updated python to python3 in Dockerfile generated upon `wasp build`.

waspc/README.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@ If you would like to make your first contribution, here is a handy checklist we
1111
- [ ] Read [Quick overview](#quick-overview).
1212
- [ ] Compile the project successfully and get todoApp example running (follow [Basics](#basics)).
1313
- [ ] Join [Discord](https://discord.gg/rzdnErX) and say hi :)!
14-
- [ ] Pick an issue [labeled with "good first issue"](https://github.com/wasp-lang/wasp/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) and let us know you would like to work on it - ideally immediatelly propose a plan of action and ask questions.
15-
If you can't find a suitable issue for you, reach out to us on Discord and we can try to find smth for you together.
14+
- [ ] Pick an issue [labeled with "good first issue"](https://github.com/wasp-lang/wasp/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) and let us know you would like to work on it - ideally immediately propose a plan of action and ask questions.
15+
If you can't find a suitable issue for you, reach out to us on Discord and we can try to find something for you together.
1616
- [ ] Make a PR targeting `main` and have it accepted! Check [Typical workflow](#typical-development-workflow) and [Branching and merging strategy](#branching-and-merging-strategy) for guidance, and consult [Codebase overview](#codebase-overview) for more details on how Wasp compiler works internally.
1717

1818
## Quick overview
@@ -21,7 +21,7 @@ Wasp compiler is implemented in Haskell, but you will also see a lot of Javascri
2121

2222
You don't have to be expert in Haskell to contribute or understand the code, since we don't use complicated Haskell features much -> most of the code is relatively simple and straight-forward, and we are happy to help with the part that is not.
2323

24-
Main result of building the project is `wasp` executable (also reffered to as CLI), which is both Wasp compiler, CLI and Wasp project runner in one - one tool for everything Wasp-related.
24+
Main result of building the project is `wasp` executable (also referred to as CLI), which is both Wasp compiler, CLI and Wasp project runner in one - one tool for everything Wasp-related.
2525

2626
`wasp` executable takes `.wasp` files and `ext/` dir as input and generates a web app from them.
2727

@@ -125,7 +125,7 @@ NOTE: Reload page if blank.
125125
Rinse and repeat.
126126
4. Run `cabal test` to confirm that the project's unit and integration tests are passing (both new and old).
127127
5. For easily testing the changes you did on a Wasp app, you have `examples/todoApp`, which we always keep updated. Also, if you added a new feature, add it to this app. Check its README for more details (including how to run it).
128-
6. There is also `headless-test/examples/todoApp`, that comes equiped with Playwright tests. This one is not so much for experimenting as `examples/todoApp` is, but more for running Playwright tests in the CI. Make sure this one is also passing, and add a new feature to it (+ tests) if needed. We will be merging this one with `examples/todoApp` in the future so it is a single app.
128+
6. There is also `headless-test/examples/todoApp`, that comes equipped with Playwright tests. This one is not so much for experimenting as `examples/todoApp` is, but more for running Playwright tests in the CI. Make sure this one is also passing, and add a new feature to it (+ tests) if needed. We will be merging this one with `examples/todoApp` in the future so it is a single app.
129129
7. If you did a bug fix, added new feature or did a breaking change, add short info about it to Changelog.md. Also, bump version in waspc.cabal and ChangeLog.md if needed -> check the version of latest release when doing it. If you are not sure how to decide which version to go with, check later in this file instructions on it.
130130
8. Squash all the commits into a single commit (or a few in case it makes more sense) and create a PR.
131131
Keep an eye on CI tests -> they should all be passing, if not, look into it.
@@ -142,7 +142,7 @@ In order to better support a wider range of developer operating systems, we have
142142
If the feature you are implementing is complex, be it due to its design or technical implementation, we recommend creating a [design doc](https://www.industrialempathy.com/posts/design-docs-at-google/) (aka RFC).
143143
It is a great way to share the idea you have with others while also getting help and feedback.
144144

145-
To create one, make a PR that adds a markdown document under `wasp/docs/design-docs`, and in that markdown document explain the thinking behind and choice made when deciding how to implement a feature.
145+
To create one, make a PR that adds a markdown document under `wasp/docs/design-docs`, and in that markdown document explain the thinking behind and choices made when deciding how to implement a feature.
146146

147147
Others will comment on your design doc, and once it has gone through needed iterations and is approved, you can start with the implementation of the feature (in a separate PR).
148148

waspc/docs/design-docs/db-seeding.org

+1-1
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ There are two main solutions:
4848
2. Seeding script
4949

5050
*** Database snapshots
51-
Database snapshots sound relatively straight forward to implement, also easy for devs to create.
51+
Database snapshots sound relatively straightforward to implement, also easy for devs to create.
5252
So they could use the app itself, or =db studio=, or some richer postgresql client, or their own scripts,
5353
to put db into a certain state, and then they can do snapshot and there you go.
5454
What is not great is that data can easily become out of sync with how app currently works,

waspc/docs/design-docs/server-setup.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ The solution that people suggested was an async function that returns an object
4343
### Advanced
4444
- Instead of returning an object that will be added to `context`, function could return a function that modifies the `context`.
4545
This gives more control to dev, but it can also lead to them messing up `context`.
46-
- Function could take arguments which expose certain parts of the server and therefore give the dev an ooportunity to affect certain parts of the app.
46+
- Function could take arguments which expose certain parts of the server and therefore give the dev an opportunity to affect certain parts of the app.
4747
For example, they could modify the expressJS router. Or they would get access to Prisma.
4848
This again can be problematic as if gives developer space to mess things up.
4949
- Function could return not just object to be added to `context`, but also other things that modify how Wasp works.

waspc/src/Wasp/Generator/Job/Process.hs

+1-1
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ runNodeCommandAsJobWithExtraEnv extraEnvVars fromDir command args jobType chan =
104104
runProcessAsJob nodeCommandProcess jobType chan
105105
where
106106
-- Haskell will use the first value for variable name it finds. Since env
107-
-- vars in 'extraEnvVars' should override the the inherited env vars, we
107+
-- vars in 'extraEnvVars' should override the inherited env vars, we
108108
-- must prepend them.
109109
getAllEnvVars = (extraEnvVars ++) <$> getEnvironment
110110
exitWithError exitCode errorMsg = do

web/blog/2021-09-01-haskell-forall-tutorial.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ This code does not compile, because compiler can't match type of `ys` with the r
9999
Why though, when they are both `[a]`? Well, that is because that is not the same `a`!
100100
Try changing `ys :: [a]` to `ys :: [b]` and you will get the exact same error,
101101
because it is exactly the same code -> `a` in `ys :: [a]` and `a` in `f :: [a] -> [a]` are different `a`s and there is no connection between them.
102-
`a` in `ys :: [a]` stands for "any type", not for "that type that is reffered to with `a` in the type signature above".
102+
`a` in `ys :: [a]` stands for "any type", not for "that type that is referred to with `a` in the type signature above".
103103

104104
This is where `ScopedTypeVariables` comes in:
105105
```hs

web/blog/2022-11-29-wasp-beta.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ Since the [launch of Wasp Alpha](https://news.ycombinator.com/item?id=26091956)
3434
- [Farnance: SaaS for farmers, a HackLBS 2021 winner](/blog/2022/10/28/farnance-hackathon-winner)
3535
- [Amicus: Planning and workflow tracking for legal teams](/blog/2022/11/26/erlis-amicus-usecase)
3636

37-
Here are the the new features that ship with Beta:
37+
Here are the new features that ship with Beta:
3838

3939
### 🟦 TypeScript support
4040

web/blog/2023-02-02-no-best-framework.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ The fact that so many libraries and frameworks exist in 2023, and that **the bes
2727

2828
<!--truncate-->
2929

30-
For example, according the the [StateOfJS](https://2022.stateofjs.com/en-US/libraries/front-end-frameworks/) survey, there were 5 Front-end Frameworks with good retention in 2018, now there are 11 in 2022. That’s a 120% increase in a matter of 4 years, and that’s not even taking into account the hot meta-frameworks like NextJS, SvelteKit, or Astro!
30+
For example, according the [StateOfJS](https://2022.stateofjs.com/en-US/libraries/front-end-frameworks/) survey, there were 5 Front-end Frameworks with good retention in 2018, now there are 11 in 2022. That’s a 120% increase in a matter of 4 years, and that’s not even taking into account the hot meta-frameworks like NextJS, SvelteKit, or Astro!
3131

3232
<br/>
3333
<ImgWithCaption

web/blog/2023-09-17-ai-meme-generator-how-to-use-openai-function-call.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1093,7 +1093,7 @@ export const editMeme: EditMeme<EditMemeArgs, Meme> = async ({ id, text0, text1
10931093
};
10941094
```
10951095

1096-
As you can see, this function expects the `id` of the already existing meme, along with the new `text` boxes. That’s because we’re letting the user manually input/edit the text that GPT generated, rather than making another request the the OpenAI API.
1096+
As you can see, this function expects the `id` of the already existing meme, along with the new `text` boxes. That’s because we’re letting the user manually input/edit the text that GPT generated, rather than making another request the OpenAI API.
10971097

10981098
Next, we look for that specific meme in our database, and if we don’t find it we throw an error (`findUniqueOrThrow`).
10991099

web/blog/2024-09-30-wasp-launch-week-7.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ Let's take a look together at the nice things that v0.15 brings us:
5757

5858
As mentioned above, we got to keep up with the trends! Here's what's new:
5959
- **Upgraded Prisma to v5** - no major interface changes, but brings a lot of performance improvements which also make Wasp faster by default 🏎️
60-
- **React Router is now at v6** - v6 has been around for a while (you can see the the main changes from v5 [here](https://blog.saeloun.com/2021/12/02/new-features-in-react-router-6/)) and it made the code even more compact and elegant.
60+
- **React Router is now at v6** - v6 has been around for a while (you can see the main changes from v5 [here](https://blog.saeloun.com/2021/12/02/new-features-in-react-router-6/)) and it made the code even more compact and elegant.
6161
- **We cleaned up and bumped a lot of other dependencies** - including Express.js on which we base Wasp’s API layer and our type-safe RPC.
6262

6363
## #2: TS SDK early preview 🤩 - give it a spin and let us know what you think!

web/docs/advanced/deployment/cli.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -246,7 +246,7 @@ Make sure to add your client-side environment variables every time you redeploy
246246

247247
### `cmd`
248248

249-
If want to run arbitrary Fly commands (e.g. `flyctl secrets list` for your server app), here's how to do it:
249+
If you want to run arbitrary Fly commands (e.g. `flyctl secrets list` for your server app), here's how to do it:
250250

251251
```shell
252252
wasp deploy fly cmd secrets list --context server

web/docs/advanced/jobs.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -292,7 +292,7 @@ The Job declaration has the following fields:
292292
type Input = { name: string; }
293293
type Output = { tasks: Task[]; }
294294
295-
export const foo: MySpecialJob<Input, Output> = async (args, context) => {
295+
export const foo: MySpecialJob<Input, Output> = async ({ name }, context) => {
296296
console.log(`Hello ${name}!`)
297297
const tasks = await context.entities.Task.findMany({})
298298
return { tasks }

web/docs/auth/_user-signup-fields-explainer.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ export const userSignupFields = defineUserSignupFields({
1212
throw new Error('Address is required')
1313
}
1414
return data.address
15-
}
15+
},
1616
phone: (data) => data.phone,
1717
})
1818
```

web/docs/auth/entities/_email-data.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
```ts
22
const emailIdentity = user.identities.email
33

4-
// Email address the the user used to sign up, e.g. "fluffyllama@app.com".
4+
// Email address the user used to sign up, e.g. "fluffyllama@app.com".
55
emailIdentity.id
66

77
// `true` if the user has verified their email address.

web/docs/data-model/operations/queries.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -607,7 +607,7 @@ import { getFoo } from 'wasp/client/operations'
607607
import { getFoo } from 'wasp/server/operations'
608608
```
609609

610-
On the the client, the Query expects
610+
On the client, the Query expects
611611

612612
</TabItem>
613613
<TabItem value="ts" label="TypeScript">

web/versioned_docs/version-0.11.8/advanced/deployment/cli.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -205,7 +205,7 @@ wasp deploy fly deploy
205205

206206
### `cmd`
207207

208-
If want to run arbitrary Fly commands (e.g. `flyctl secrets list` for your server app), here's how to do it:
208+
If you want to run arbitrary Fly commands (e.g. `flyctl secrets list` for your server app), here's how to do it:
209209

210210
```shell
211211
wasp deploy fly cmd secrets list --context server

web/versioned_docs/version-0.11.8/advanced/deployment/manually.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -301,7 +301,7 @@ Let's deploy our server first:
301301
Open the `Settings` and go to the `Variables` tab:
302302

303303
- click **Variable reference** and select `DATABASE_URL` (it will populate it with the correct value)
304-
- add `WASP_WEB_CLIENT_URL` - enter the the `client` domain (e.g. `https://client-production-XXXX.up.railway.app`)
304+
- add `WASP_WEB_CLIENT_URL` - enter the `client` domain (e.g. `https://client-production-XXXX.up.railway.app`)
305305
- add `JWT_SECRET` - enter a random string at least 32 characters long (use an [online generator](https://djecrety.ir/))
306306

307307
<AddExternalAuthEnvVarsReminder />

web/versioned_docs/version-0.12.0/advanced/deployment/cli.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -209,7 +209,7 @@ wasp deploy fly deploy
209209

210210
### `cmd`
211211

212-
If want to run arbitrary Fly commands (e.g. `flyctl secrets list` for your server app), here's how to do it:
212+
If you want to run arbitrary Fly commands (e.g. `flyctl secrets list` for your server app), here's how to do it:
213213

214214
```shell
215215
wasp deploy fly cmd secrets list --context server

web/versioned_docs/version-0.12.0/advanced/deployment/manually.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -324,7 +324,7 @@ Let's deploy our server first:
324324
Open the `Settings` and go to the `Variables` tab:
325325

326326
- click **Variable reference** and select `DATABASE_URL` (it will populate it with the correct value)
327-
- add `WASP_WEB_CLIENT_URL` - enter the the `client` domain (e.g. `https://client-production-XXXX.up.railway.app`)
327+
- add `WASP_WEB_CLIENT_URL` - enter the `client` domain (e.g. `https://client-production-XXXX.up.railway.app`)
328328
- add `JWT_SECRET` - enter a random string at least 32 characters long (use an [online generator](https://djecrety.ir/))
329329

330330
<AddExternalAuthEnvVarsReminder />

web/versioned_docs/version-0.13.0/advanced/deployment/cli.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -209,7 +209,7 @@ wasp deploy fly deploy
209209

210210
### `cmd`
211211

212-
If want to run arbitrary Fly commands (e.g. `flyctl secrets list` for your server app), here's how to do it:
212+
If you want to run arbitrary Fly commands (e.g. `flyctl secrets list` for your server app), here's how to do it:
213213

214214
```shell
215215
wasp deploy fly cmd secrets list --context server

web/versioned_docs/version-0.14.0/advanced/deployment/cli.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -246,7 +246,7 @@ Make sure to add your client-side environment variables every time you redeploy
246246

247247
### `cmd`
248248

249-
If want to run arbitrary Fly commands (e.g. `flyctl secrets list` for your server app), here's how to do it:
249+
If you want to run arbitrary Fly commands (e.g. `flyctl secrets list` for your server app), here's how to do it:
250250

251251
```shell
252252
wasp deploy fly cmd secrets list --context server

web/versioned_docs/version-0.14.0/auth/entities/_email-data.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
```ts
22
const emailIdentity = user.identities.email
33

4-
// Email address the the user used to sign up, e.g. "fluffyllama@app.com".
4+
// Email address the user used to sign up, e.g. "fluffyllama@app.com".
55
emailIdentity.id
66

77
// `true` if the user has verified their email address.

web/versioned_docs/version-0.14.0/data-model/operations/queries.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -607,7 +607,7 @@ import { getFoo } from 'wasp/client/operations'
607607
import { getFoo } from 'wasp/server/operations'
608608
```
609609

610-
On the the client, the Query expects
610+
On the client, the Query expects
611611

612612
</TabItem>
613613
<TabItem value="ts" label="TypeScript">

web/versioned_docs/version-0.15.0/advanced/deployment/cli.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -246,7 +246,7 @@ Make sure to add your client-side environment variables every time you redeploy
246246

247247
### `cmd`
248248

249-
If want to run arbitrary Fly commands (e.g. `flyctl secrets list` for your server app), here's how to do it:
249+
If you want to run arbitrary Fly commands (e.g. `flyctl secrets list` for your server app), here's how to do it:
250250

251251
```shell
252252
wasp deploy fly cmd secrets list --context server

web/versioned_docs/version-0.15.0/auth/entities/_email-data.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
```ts
22
const emailIdentity = user.identities.email
33

4-
// Email address the the user used to sign up, e.g. "fluffyllama@app.com".
4+
// Email address the user used to sign up, e.g. "fluffyllama@app.com".
55
emailIdentity.id
66

77
// `true` if the user has verified their email address.

web/versioned_docs/version-0.15.0/data-model/operations/queries.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -607,7 +607,7 @@ import { getFoo } from 'wasp/client/operations'
607607
import { getFoo } from 'wasp/server/operations'
608608
```
609609

610-
On the the client, the Query expects
610+
On the client, the Query expects
611611

612612
</TabItem>
613613
<TabItem value="ts" label="TypeScript">

0 commit comments

Comments
 (0)