Skip to content

Commit e88f187

Browse files
DePasqualeOrgigalklebanov
authored andcommitted
Fix spelling, punctuation, grammar (kysely-org#969)
Co-authored-by: Igal Klebanov <[email protected]>
1 parent 63bb3b2 commit e88f187

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

56 files changed

+99
-99
lines changed

CONTRIBUTING.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ There are quite a few guidelines to keep in mind:
1515

1616
* Kysely should have zero dependencies.
1717

18-
* Kysely should work in all javascript environments (node.js, deno & modern browsers),
18+
* Kysely should work in all JavaScript environments (node.js, deno & modern browsers),
1919
even though the main focus is node.js.
2020

2121
* Everything is immutable.

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ If you start using Kysely and can't find something you'd want to use, please ope
4040
# Getting started
4141

4242
Please visit our documentation site [kysely.dev](https://kysely.dev) to get started. We also have a comprehensive
43-
API documentation hosted [here](https://kysely-org.github.io/kysely-apidoc/) but you can access the same
43+
API documentation hosted [here](https://kysely-org.github.io/kysely-apidoc/), but you can access the same
4444
documentation in your IDE by hovering over a class/method/property/whatever.
4545

4646
# Contributors

scripts/add-deno-type-references.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
/**
22
* This scripts adds a `/// <reference types="./file.d.ts" />` directive
3-
* at the beginning of each ESM javascript file so that they work with
3+
* at the beginning of each ESM JavaScript file so that they work with
44
* deno.
55
*/
66

scripts/generate-site-examples.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -209,7 +209,7 @@ function buildMoreExamplesMarkdown(category) {
209209

210210
const lines = [
211211
':::info More examples',
212-
'The API documentation is packed with examples. The API docs are hosted [here](https://kysely-org.github.io/kysely-apidoc/)',
212+
'The API documentation is packed with examples. The API docs are hosted [here](https://kysely-org.github.io/kysely-apidoc/),',
213213
'but you can access the same documentation by hovering over functions/methods/classes in your IDE. The examples are always',
214214
'just one hover away!',
215215
'',

site/docs/examples/DELETE/0010-single-row.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ import {
2020
</div>
2121

2222
:::info More examples
23-
The API documentation is packed with examples. The API docs are hosted [here](https://kysely-org.github.io/kysely-apidoc/)
23+
The API documentation is packed with examples. The API docs are hosted [here](https://kysely-org.github.io/kysely-apidoc/),
2424
but you can access the same documentation by hovering over functions/methods/classes in your IDE. The examples are always
2525
just one hover away!
2626

site/docs/examples/INSERT/0010-single-row.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ import {
2020
</div>
2121

2222
:::info More examples
23-
The API documentation is packed with examples. The API docs are hosted [here](https://kysely-org.github.io/kysely-apidoc/)
23+
The API documentation is packed with examples. The API docs are hosted [here](https://kysely-org.github.io/kysely-apidoc/),
2424
but you can access the same documentation by hovering over functions/methods/classes in your IDE. The examples are always
2525
just one hover away!
2626

site/docs/examples/INSERT/0020-multiple-rows.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ import {
2323
</div>
2424

2525
:::info More examples
26-
The API documentation is packed with examples. The API docs are hosted [here](https://kysely-org.github.io/kysely-apidoc/)
26+
The API documentation is packed with examples. The API docs are hosted [here](https://kysely-org.github.io/kysely-apidoc/),
2727
but you can access the same documentation by hovering over functions/methods/classes in your IDE. The examples are always
2828
just one hover away!
2929

site/docs/examples/INSERT/0030-returning-data.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ import {
2323
</div>
2424

2525
:::info More examples
26-
The API documentation is packed with examples. The API docs are hosted [here](https://kysely-org.github.io/kysely-apidoc/)
26+
The API documentation is packed with examples. The API docs are hosted [here](https://kysely-org.github.io/kysely-apidoc/),
2727
but you can access the same documentation by hovering over functions/methods/classes in your IDE. The examples are always
2828
just one hover away!
2929

site/docs/examples/INSERT/0040-complex-values.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ import {
2222
</div>
2323

2424
:::info More examples
25-
The API documentation is packed with examples. The API docs are hosted [here](https://kysely-org.github.io/kysely-apidoc/)
25+
The API documentation is packed with examples. The API docs are hosted [here](https://kysely-org.github.io/kysely-apidoc/),
2626
but you can access the same documentation by hovering over functions/methods/classes in your IDE. The examples are always
2727
just one hover away!
2828

site/docs/examples/INSERT/0050-insert-subquery.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ import {
2222
</div>
2323

2424
:::info More examples
25-
The API documentation is packed with examples. The API docs are hosted [here](https://kysely-org.github.io/kysely-apidoc/)
25+
The API documentation is packed with examples. The API docs are hosted [here](https://kysely-org.github.io/kysely-apidoc/),
2626
but you can access the same documentation by hovering over functions/methods/classes in your IDE. The examples are always
2727
just one hover away!
2828

site/docs/examples/JOIN/0010-simple-inner-join.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ import {
2020
</div>
2121

2222
:::info More examples
23-
The API documentation is packed with examples. The API docs are hosted [here](https://kysely-org.github.io/kysely-apidoc/)
23+
The API documentation is packed with examples. The API docs are hosted [here](https://kysely-org.github.io/kysely-apidoc/),
2424
but you can access the same documentation by hovering over functions/methods/classes in your IDE. The examples are always
2525
just one hover away!
2626

site/docs/examples/JOIN/0020-aliased-inner-join.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ import {
2020
</div>
2121

2222
:::info More examples
23-
The API documentation is packed with examples. The API docs are hosted [here](https://kysely-org.github.io/kysely-apidoc/)
23+
The API documentation is packed with examples. The API docs are hosted [here](https://kysely-org.github.io/kysely-apidoc/),
2424
but you can access the same documentation by hovering over functions/methods/classes in your IDE. The examples are always
2525
just one hover away!
2626

site/docs/examples/JOIN/0030-complex-join.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ import {
2828
</div>
2929

3030
:::info More examples
31-
The API documentation is packed with examples. The API docs are hosted [here](https://kysely-org.github.io/kysely-apidoc/)
31+
The API documentation is packed with examples. The API docs are hosted [here](https://kysely-org.github.io/kysely-apidoc/),
3232
but you can access the same documentation by hovering over functions/methods/classes in your IDE. The examples are always
3333
just one hover away!
3434

site/docs/examples/JOIN/0040-subquery-join.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ import {
2020
</div>
2121

2222
:::info More examples
23-
The API documentation is packed with examples. The API docs are hosted [here](https://kysely-org.github.io/kysely-apidoc/)
23+
The API documentation is packed with examples. The API docs are hosted [here](https://kysely-org.github.io/kysely-apidoc/),
2424
but you can access the same documentation by hovering over functions/methods/classes in your IDE. The examples are always
2525
just one hover away!
2626

site/docs/examples/SELECT/0010-a-single-column.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ import {
2020
</div>
2121

2222
:::info More examples
23-
The API documentation is packed with examples. The API docs are hosted [here](https://kysely-org.github.io/kysely-apidoc/)
23+
The API documentation is packed with examples. The API docs are hosted [here](https://kysely-org.github.io/kysely-apidoc/),
2424
but you can access the same documentation by hovering over functions/methods/classes in your IDE. The examples are always
2525
just one hover away!
2626

site/docs/examples/SELECT/0020-column-with-a-table.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ import {
2020
</div>
2121

2222
:::info More examples
23-
The API documentation is packed with examples. The API docs are hosted [here](https://kysely-org.github.io/kysely-apidoc/)
23+
The API documentation is packed with examples. The API docs are hosted [here](https://kysely-org.github.io/kysely-apidoc/),
2424
but you can access the same documentation by hovering over functions/methods/classes in your IDE. The examples are always
2525
just one hover away!
2626

site/docs/examples/SELECT/0030-multiple-columns.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ import {
2020
</div>
2121

2222
:::info More examples
23-
The API documentation is packed with examples. The API docs are hosted [here](https://kysely-org.github.io/kysely-apidoc/)
23+
The API documentation is packed with examples. The API docs are hosted [here](https://kysely-org.github.io/kysely-apidoc/),
2424
but you can access the same documentation by hovering over functions/methods/classes in your IDE. The examples are always
2525
just one hover away!
2626

site/docs/examples/SELECT/0040-aliases.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ import {
2020
</div>
2121

2222
:::info More examples
23-
The API documentation is packed with examples. The API docs are hosted [here](https://kysely-org.github.io/kysely-apidoc/)
23+
The API documentation is packed with examples. The API docs are hosted [here](https://kysely-org.github.io/kysely-apidoc/),
2424
but you can access the same documentation by hovering over functions/methods/classes in your IDE. The examples are always
2525
just one hover away!
2626

site/docs/examples/SELECT/0050-complex-selections.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ import {
2121
</div>
2222

2323
:::info More examples
24-
The API documentation is packed with examples. The API docs are hosted [here](https://kysely-org.github.io/kysely-apidoc/)
24+
The API documentation is packed with examples. The API docs are hosted [here](https://kysely-org.github.io/kysely-apidoc/),
2525
but you can access the same documentation by hovering over functions/methods/classes in your IDE. The examples are always
2626
just one hover away!
2727

site/docs/examples/SELECT/0051-not-null.mdx

+3-3
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@ title: 'Not null'
55
# Not null
66

77
Sometimes you can be sure something's not null but Kysely isn't able to infer
8-
it. For example calling `where('last_name', 'is not', null)` doesn't make
9-
`last_name` not null in the result type but unless you have other where statements
8+
it. For example, calling `where('last_name', 'is not', null)` doesn't make
9+
`last_name` not null in the result type, but unless you have other where statements,
1010
you can be sure it's never null.
1111

1212
Kysely has a couple of helpers for dealing with these cases: `$notNull()` and `$narrowType`.
@@ -26,7 +26,7 @@ import {
2626
</div>
2727

2828
:::info More examples
29-
The API documentation is packed with examples. The API docs are hosted [here](https://kysely-org.github.io/kysely-apidoc/)
29+
The API documentation is packed with examples. The API docs are hosted [here](https://kysely-org.github.io/kysely-apidoc/),
3030
but you can access the same documentation by hovering over functions/methods/classes in your IDE. The examples are always
3131
just one hover away!
3232

site/docs/examples/SELECT/0060-function-calls.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ import {
2222
</div>
2323

2424
:::info More examples
25-
The API documentation is packed with examples. The API docs are hosted [here](https://kysely-org.github.io/kysely-apidoc/)
25+
The API documentation is packed with examples. The API docs are hosted [here](https://kysely-org.github.io/kysely-apidoc/),
2626
but you can access the same documentation by hovering over functions/methods/classes in your IDE. The examples are always
2727
just one hover away!
2828

site/docs/examples/SELECT/0070-distinct.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ import {
2020
</div>
2121

2222
:::info More examples
23-
The API documentation is packed with examples. The API docs are hosted [here](https://kysely-org.github.io/kysely-apidoc/)
23+
The API documentation is packed with examples. The API docs are hosted [here](https://kysely-org.github.io/kysely-apidoc/),
2424
but you can access the same documentation by hovering over functions/methods/classes in your IDE. The examples are always
2525
just one hover away!
2626

site/docs/examples/SELECT/0080-distinct-on.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ import {
1818
</div>
1919

2020
:::info More examples
21-
The API documentation is packed with examples. The API docs are hosted [here](https://kysely-org.github.io/kysely-apidoc/)
21+
The API documentation is packed with examples. The API docs are hosted [here](https://kysely-org.github.io/kysely-apidoc/),
2222
but you can access the same documentation by hovering over functions/methods/classes in your IDE. The examples are always
2323
just one hover away!
2424

site/docs/examples/SELECT/0090-all-columns.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ import {
2020
</div>
2121

2222
:::info More examples
23-
The API documentation is packed with examples. The API docs are hosted [here](https://kysely-org.github.io/kysely-apidoc/)
23+
The API documentation is packed with examples. The API docs are hosted [here](https://kysely-org.github.io/kysely-apidoc/),
2424
but you can access the same documentation by hovering over functions/methods/classes in your IDE. The examples are always
2525
just one hover away!
2626

site/docs/examples/SELECT/0100-all-columns-of-a-table.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ import {
2020
</div>
2121

2222
:::info More examples
23-
The API documentation is packed with examples. The API docs are hosted [here](https://kysely-org.github.io/kysely-apidoc/)
23+
The API documentation is packed with examples. The API docs are hosted [here](https://kysely-org.github.io/kysely-apidoc/),
2424
but you can access the same documentation by hovering over functions/methods/classes in your IDE. The examples are always
2525
just one hover away!
2626

site/docs/examples/SELECT/0110-nested-array.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ use the `jsonArrayFrom` helper to fetch person's pets along with the person's id
1111
Please keep in mind that the helpers under the `kysely/helpers` folder, including
1212
`jsonArrayFrom`, are not guaranteed to work with third party dialects. In order for
1313
them to work, the dialect must automatically parse the `json` data type into
14-
javascript JSON values like objects and arrays. Some dialects might simply return
14+
JavaScript JSON values like objects and arrays. Some dialects might simply return
1515
the data as a JSON string. In these cases you can use the built in `ParseJSONResultsPlugin`
1616
to parse the results.
1717

@@ -29,7 +29,7 @@ import {
2929
</div>
3030

3131
:::info More examples
32-
The API documentation is packed with examples. The API docs are hosted [here](https://kysely-org.github.io/kysely-apidoc/)
32+
The API documentation is packed with examples. The API docs are hosted [here](https://kysely-org.github.io/kysely-apidoc/),
3333
but you can access the same documentation by hovering over functions/methods/classes in your IDE. The examples are always
3434
just one hover away!
3535

site/docs/examples/SELECT/0120-nested-object.mdx

+3-3
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@ helpers for fetching nested objects and arrays in a single query. In this exampl
99
use the `jsonObjectFrom` helper to fetch person's favorite pet along with the person's id.
1010

1111
Please keep in mind that the helpers under the `kysely/helpers` folder, including
12-
`jsonObjectFrom`, are not guaranteed to work with 3rd party dialects. In order for
12+
`jsonObjectFrom`, are not guaranteed to work with third-party dialects. In order for
1313
them to work, the dialect must automatically parse the `json` data type into
14-
javascript JSON values like objects and arrays. Some dialects might simply return
14+
JavaScript JSON values like objects and arrays. Some dialects might simply return
1515
the data as a JSON string. In these cases you can use the built in `ParseJSONResultsPlugin`
1616
to parse the results.
1717

@@ -29,7 +29,7 @@ import {
2929
</div>
3030

3131
:::info More examples
32-
The API documentation is packed with examples. The API docs are hosted [here](https://kysely-org.github.io/kysely-apidoc/)
32+
The API documentation is packed with examples. The API docs are hosted [here](https://kysely-org.github.io/kysely-apidoc/),
3333
but you can access the same documentation by hovering over functions/methods/classes in your IDE. The examples are always
3434
just one hover away!
3535

site/docs/examples/UPDATE/0010-single-row.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ import {
2020
</div>
2121

2222
:::info More examples
23-
The API documentation is packed with examples. The API docs are hosted [here](https://kysely-org.github.io/kysely-apidoc/)
23+
The API documentation is packed with examples. The API docs are hosted [here](https://kysely-org.github.io/kysely-apidoc/),
2424
but you can access the same documentation by hovering over functions/methods/classes in your IDE. The examples are always
2525
just one hover away!
2626

site/docs/examples/UPDATE/0020-complex-values.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ import {
2121
</div>
2222

2323
:::info More examples
24-
The API documentation is packed with examples. The API docs are hosted [here](https://kysely-org.github.io/kysely-apidoc/)
24+
The API documentation is packed with examples. The API docs are hosted [here](https://kysely-org.github.io/kysely-apidoc/),
2525
but you can access the same documentation by hovering over functions/methods/classes in your IDE. The examples are always
2626
just one hover away!
2727

site/docs/examples/WHERE/0010-simple-where-clause.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ import {
2020
</div>
2121

2222
:::info More examples
23-
The API documentation is packed with examples. The API docs are hosted [here](https://kysely-org.github.io/kysely-apidoc/)
23+
The API documentation is packed with examples. The API docs are hosted [here](https://kysely-org.github.io/kysely-apidoc/),
2424
but you can access the same documentation by hovering over functions/methods/classes in your IDE. The examples are always
2525
just one hover away!
2626

site/docs/examples/WHERE/0020-where-in.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ import {
2020
</div>
2121

2222
:::info More examples
23-
The API documentation is packed with examples. The API docs are hosted [here](https://kysely-org.github.io/kysely-apidoc/)
23+
The API documentation is packed with examples. The API docs are hosted [here](https://kysely-org.github.io/kysely-apidoc/),
2424
but you can access the same documentation by hovering over functions/methods/classes in your IDE. The examples are always
2525
just one hover away!
2626

site/docs/examples/WHERE/0030-object-filter.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ import {
2121
</div>
2222

2323
:::info More examples
24-
The API documentation is packed with examples. The API docs are hosted [here](https://kysely-org.github.io/kysely-apidoc/)
24+
The API documentation is packed with examples. The API docs are hosted [here](https://kysely-org.github.io/kysely-apidoc/),
2525
but you can access the same documentation by hovering over functions/methods/classes in your IDE. The examples are always
2626
just one hover away!
2727

site/docs/examples/WHERE/0040-or-where.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ import {
2222
</div>
2323

2424
:::info More examples
25-
The API documentation is packed with examples. The API docs are hosted [here](https://kysely-org.github.io/kysely-apidoc/)
25+
The API documentation is packed with examples. The API docs are hosted [here](https://kysely-org.github.io/kysely-apidoc/),
2626
but you can access the same documentation by hovering over functions/methods/classes in your IDE. The examples are always
2727
just one hover away!
2828

site/docs/examples/WHERE/0050-conditional-where-calls.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ import {
2020
</div>
2121

2222
:::info More examples
23-
The API documentation is packed with examples. The API docs are hosted [here](https://kysely-org.github.io/kysely-apidoc/)
23+
The API documentation is packed with examples. The API docs are hosted [here](https://kysely-org.github.io/kysely-apidoc/),
2424
but you can access the same documentation by hovering over functions/methods/classes in your IDE. The examples are always
2525
just one hover away!
2626

site/docs/examples/WHERE/0060-complex-where-clause.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ import {
2121
</div>
2222

2323
:::info More examples
24-
The API documentation is packed with examples. The API docs are hosted [here](https://kysely-org.github.io/kysely-apidoc/)
24+
The API documentation is packed with examples. The API docs are hosted [here](https://kysely-org.github.io/kysely-apidoc/),
2525
but you can access the same documentation by hovering over functions/methods/classes in your IDE. The examples are always
2626
just one hover away!
2727

site/docs/examples/transactions/0010-simple-transaction.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ import {
2222
</div>
2323

2424
:::info More examples
25-
The API documentation is packed with examples. The API docs are hosted [here](https://kysely-org.github.io/kysely-apidoc/)
25+
The API documentation is packed with examples. The API docs are hosted [here](https://kysely-org.github.io/kysely-apidoc/),
2626
but you can access the same documentation by hovering over functions/methods/classes in your IDE. The examples are always
2727
just one hover away!
2828

site/docs/generating-types.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,10 @@ To work with Kysely, you're required to provide a database schema type definitio
44

55
In many cases, defining your database schema definitions manually is good enough.
66

7-
However, when building production applications, its best to stay aligned with the
7+
However, when building production applications, it's best to stay aligned with the
88
database schema, by automatically generating the database schema type definitions.
99

10-
There are several ways to do this using 3rd party libraries:
10+
There are several ways to do this using third-party libraries:
1111

1212
- [kysely-codegen](https://github.com/RobinBlomberg/kysely-codegen) - This library
1313
generates Kysely database schema type definitions by connecting to and introspecting

site/docs/getting-started/_types.mdx

+3-3
Original file line numberDiff line numberDiff line change
@@ -90,9 +90,9 @@ might differ in naming convention, internal order, etc. Find out more at ["Gener
9090
9191
:::info Runtime types
9292
93-
Kysely only deals with types in the typescript level. The runtime javascript types are decided
94-
by the underlying 3rd party driver such as `pg` or `mysql2` and it's up to you to select the correct
95-
typescript types in the database interface. Kysely never touches the runtime output types in
93+
Kysely only deals with types in the TypeScript level. The runtime JavaScript types are decided
94+
by the underlying third-party driver such as `pg` or `mysql2` and it's up to you to select the correct
95+
TypeScript types in the database interface. Kysely never touches the runtime output types in
9696
any way. Find out more at ["Data types"](https://kysely.dev/docs/recipes/data-types).
9797
9898
:::

0 commit comments

Comments
 (0)