Skip to content

Commit

Permalink
Fix spelling, punctuation, grammar (#969)
Browse files Browse the repository at this point in the history
Co-authored-by: Igal Klebanov <[email protected]>
  • Loading branch information
DePasqualeOrg and igalklebanov authored Apr 30, 2024
1 parent 0895d62 commit deea8e2
Show file tree
Hide file tree
Showing 56 changed files with 99 additions and 99 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ There are quite a few guidelines to keep in mind:

* Kysely should have zero dependencies.

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

* Everything is immutable.
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ If you start using Kysely and can't find something you'd want to use, please ope
# Getting started

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

# Contributors
Expand Down
2 changes: 1 addition & 1 deletion scripts/add-deno-type-references.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/**
* This scripts adds a `/// <reference types="./file.d.ts" />` directive
* at the beginning of each ESM javascript file so that they work with
* at the beginning of each ESM JavaScript file so that they work with
* deno.
*/

Expand Down
2 changes: 1 addition & 1 deletion scripts/generate-site-examples.js
Original file line number Diff line number Diff line change
Expand Up @@ -209,7 +209,7 @@ function buildMoreExamplesMarkdown(category) {

const lines = [
':::info More examples',
'The API documentation is packed with examples. The API docs are hosted [here](https://kysely-org.github.io/kysely-apidoc/)',
'The API documentation is packed with examples. The API docs are hosted [here](https://kysely-org.github.io/kysely-apidoc/),',
'but you can access the same documentation by hovering over functions/methods/classes in your IDE. The examples are always',
'just one hover away!',
'',
Expand Down
2 changes: 1 addition & 1 deletion site/docs/examples/DELETE/0010-single-row.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ import {
</div>

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

Expand Down
2 changes: 1 addition & 1 deletion site/docs/examples/INSERT/0010-single-row.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ import {
</div>

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

Expand Down
2 changes: 1 addition & 1 deletion site/docs/examples/INSERT/0020-multiple-rows.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ import {
</div>

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

Expand Down
2 changes: 1 addition & 1 deletion site/docs/examples/INSERT/0030-returning-data.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ import {
</div>

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

Expand Down
2 changes: 1 addition & 1 deletion site/docs/examples/INSERT/0040-complex-values.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ import {
</div>

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

Expand Down
2 changes: 1 addition & 1 deletion site/docs/examples/INSERT/0050-insert-subquery.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ import {
</div>

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

Expand Down
2 changes: 1 addition & 1 deletion site/docs/examples/JOIN/0010-simple-inner-join.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ import {
</div>

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

Expand Down
2 changes: 1 addition & 1 deletion site/docs/examples/JOIN/0020-aliased-inner-join.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ import {
</div>

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

Expand Down
2 changes: 1 addition & 1 deletion site/docs/examples/JOIN/0030-complex-join.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ import {
</div>

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

Expand Down
2 changes: 1 addition & 1 deletion site/docs/examples/JOIN/0040-subquery-join.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ import {
</div>

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

Expand Down
2 changes: 1 addition & 1 deletion site/docs/examples/SELECT/0010-a-single-column.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ import {
</div>

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

Expand Down
2 changes: 1 addition & 1 deletion site/docs/examples/SELECT/0020-column-with-a-table.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ import {
</div>

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

Expand Down
2 changes: 1 addition & 1 deletion site/docs/examples/SELECT/0030-multiple-columns.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ import {
</div>

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

Expand Down
2 changes: 1 addition & 1 deletion site/docs/examples/SELECT/0040-aliases.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ import {
</div>

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

Expand Down
2 changes: 1 addition & 1 deletion site/docs/examples/SELECT/0050-complex-selections.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ import {
</div>

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

Expand Down
6 changes: 3 additions & 3 deletions site/docs/examples/SELECT/0051-not-null.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ title: 'Not null'
# Not null

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

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

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

Expand Down
2 changes: 1 addition & 1 deletion site/docs/examples/SELECT/0060-function-calls.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ import {
</div>

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

Expand Down
2 changes: 1 addition & 1 deletion site/docs/examples/SELECT/0070-distinct.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ import {
</div>

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

Expand Down
2 changes: 1 addition & 1 deletion site/docs/examples/SELECT/0080-distinct-on.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ import {
</div>

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

Expand Down
2 changes: 1 addition & 1 deletion site/docs/examples/SELECT/0090-all-columns.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ import {
</div>

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

Expand Down
2 changes: 1 addition & 1 deletion site/docs/examples/SELECT/0100-all-columns-of-a-table.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ import {
</div>

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

Expand Down
4 changes: 2 additions & 2 deletions site/docs/examples/SELECT/0110-nested-array.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ use the `jsonArrayFrom` helper to fetch person's pets along with the person's id
Please keep in mind that the helpers under the `kysely/helpers` folder, including
`jsonArrayFrom`, are not guaranteed to work with third party dialects. In order for
them to work, the dialect must automatically parse the `json` data type into
javascript JSON values like objects and arrays. Some dialects might simply return
JavaScript JSON values like objects and arrays. Some dialects might simply return
the data as a JSON string. In these cases you can use the built in `ParseJSONResultsPlugin`
to parse the results.

Expand All @@ -29,7 +29,7 @@ import {
</div>

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

Expand Down
6 changes: 3 additions & 3 deletions site/docs/examples/SELECT/0120-nested-object.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ helpers for fetching nested objects and arrays in a single query. In this exampl
use the `jsonObjectFrom` helper to fetch person's favorite pet along with the person's id.

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

Expand All @@ -29,7 +29,7 @@ import {
</div>

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

Expand Down
2 changes: 1 addition & 1 deletion site/docs/examples/UPDATE/0010-single-row.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ import {
</div>

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

Expand Down
2 changes: 1 addition & 1 deletion site/docs/examples/UPDATE/0020-complex-values.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ import {
</div>

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

Expand Down
2 changes: 1 addition & 1 deletion site/docs/examples/WHERE/0010-simple-where-clause.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ import {
</div>

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

Expand Down
2 changes: 1 addition & 1 deletion site/docs/examples/WHERE/0020-where-in.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ import {
</div>

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

Expand Down
2 changes: 1 addition & 1 deletion site/docs/examples/WHERE/0030-object-filter.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ import {
</div>

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

Expand Down
2 changes: 1 addition & 1 deletion site/docs/examples/WHERE/0040-or-where.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ import {
</div>

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

Expand Down
2 changes: 1 addition & 1 deletion site/docs/examples/WHERE/0050-conditional-where-calls.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ import {
</div>

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

Expand Down
2 changes: 1 addition & 1 deletion site/docs/examples/WHERE/0060-complex-where-clause.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ import {
</div>

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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ import {
</div>

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

Expand Down
4 changes: 2 additions & 2 deletions site/docs/generating-types.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@ To work with Kysely, you're required to provide a database schema type definitio

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

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

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

- [kysely-codegen](https://github.com/RobinBlomberg/kysely-codegen) - This library
generates Kysely database schema type definitions by connecting to and introspecting
Expand Down
6 changes: 3 additions & 3 deletions site/docs/getting-started/_types.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -90,9 +90,9 @@ might differ in naming convention, internal order, etc. Find out more at ["Gener
:::info Runtime types
Kysely only deals with types in the typescript level. The runtime javascript types are decided
by the underlying 3rd party driver such as `pg` or `mysql2` and it's up to you to select the correct
typescript types in the database interface. Kysely never touches the runtime output types in
Kysely only deals with types in the TypeScript level. The runtime JavaScript types are decided
by the underlying third-party driver such as `pg` or `mysql2` and it's up to you to select the correct
TypeScript types in the database interface. Kysely never touches the runtime output types in
any way. Find out more at ["Data types"](https://kysely.dev/docs/recipes/data-types).
:::
Loading

0 comments on commit deea8e2

Please sign in to comment.