Fix punctuation and spelling

kysely-org · Apr 26, 2024 · c65e5b3 · c65e5b3
1 parent a228fa4
commit c65e5b3
Show file tree

Hide file tree

Showing 37 changed files with 40 additions and 40 deletions.
diff --git a/README.md b/README.md
@@ -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

diff --git a/scripts/generate-site-examples.js b/scripts/generate-site-examples.js
@@ -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!',
     '',

diff --git a/site/docs/examples/DELETE/0010-single-row.mdx b/site/docs/examples/DELETE/0010-single-row.mdx
@@ -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!
 

diff --git a/site/docs/examples/INSERT/0010-single-row.mdx b/site/docs/examples/INSERT/0010-single-row.mdx
@@ -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!
 

diff --git a/site/docs/examples/INSERT/0020-multiple-rows.mdx b/site/docs/examples/INSERT/0020-multiple-rows.mdx
@@ -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!
 

diff --git a/site/docs/examples/INSERT/0030-returning-data.mdx b/site/docs/examples/INSERT/0030-returning-data.mdx
@@ -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!
 

diff --git a/site/docs/examples/INSERT/0040-complex-values.mdx b/site/docs/examples/INSERT/0040-complex-values.mdx
@@ -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!
 

diff --git a/site/docs/examples/INSERT/0050-insert-subquery.mdx b/site/docs/examples/INSERT/0050-insert-subquery.mdx
@@ -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!
 

diff --git a/site/docs/examples/JOIN/0010-simple-inner-join.mdx b/site/docs/examples/JOIN/0010-simple-inner-join.mdx
@@ -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!
 

diff --git a/site/docs/examples/JOIN/0020-aliased-inner-join.mdx b/site/docs/examples/JOIN/0020-aliased-inner-join.mdx
@@ -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!
 

diff --git a/site/docs/examples/JOIN/0030-complex-join.mdx b/site/docs/examples/JOIN/0030-complex-join.mdx
@@ -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!
 

diff --git a/site/docs/examples/JOIN/0040-subquery-join.mdx b/site/docs/examples/JOIN/0040-subquery-join.mdx
@@ -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!
 

diff --git a/site/docs/examples/SELECT/0010-a-single-column.mdx b/site/docs/examples/SELECT/0010-a-single-column.mdx
@@ -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!
 

diff --git a/site/docs/examples/SELECT/0020-column-with-a-table.mdx b/site/docs/examples/SELECT/0020-column-with-a-table.mdx
@@ -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!
 

diff --git a/site/docs/examples/SELECT/0030-multiple-columns.mdx b/site/docs/examples/SELECT/0030-multiple-columns.mdx
@@ -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!
 

diff --git a/site/docs/examples/SELECT/0040-aliases.mdx b/site/docs/examples/SELECT/0040-aliases.mdx
@@ -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!
 

diff --git a/site/docs/examples/SELECT/0050-complex-selections.mdx b/site/docs/examples/SELECT/0050-complex-selections.mdx
@@ -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!
 

diff --git a/site/docs/examples/SELECT/0051-not-null.mdx b/site/docs/examples/SELECT/0051-not-null.mdx
@@ -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`.
@@ -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!
 

diff --git a/site/docs/examples/SELECT/0060-function-calls.mdx b/site/docs/examples/SELECT/0060-function-calls.mdx
@@ -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!
 

diff --git a/site/docs/examples/SELECT/0070-distinct.mdx b/site/docs/examples/SELECT/0070-distinct.mdx
@@ -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!
 

diff --git a/site/docs/examples/SELECT/0080-distinct-on.mdx b/site/docs/examples/SELECT/0080-distinct-on.mdx
@@ -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!
 

diff --git a/site/docs/examples/SELECT/0090-all-columns.mdx b/site/docs/examples/SELECT/0090-all-columns.mdx
@@ -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!
 

diff --git a/site/docs/examples/SELECT/0100-all-columns-of-a-table.mdx b/site/docs/examples/SELECT/0100-all-columns-of-a-table.mdx
@@ -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!
 

diff --git a/site/docs/examples/SELECT/0110-nested-array.mdx b/site/docs/examples/SELECT/0110-nested-array.mdx
@@ -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!
 

diff --git a/site/docs/examples/SELECT/0120-nested-object.mdx b/site/docs/examples/SELECT/0120-nested-object.mdx
@@ -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!
 

diff --git a/site/docs/examples/UPDATE/0010-single-row.mdx b/site/docs/examples/UPDATE/0010-single-row.mdx
@@ -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!
 

diff --git a/site/docs/examples/UPDATE/0020-complex-values.mdx b/site/docs/examples/UPDATE/0020-complex-values.mdx
@@ -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!
 

diff --git a/site/docs/examples/WHERE/0010-simple-where-clause.mdx b/site/docs/examples/WHERE/0010-simple-where-clause.mdx
@@ -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!
 

diff --git a/site/docs/examples/WHERE/0020-where-in.mdx b/site/docs/examples/WHERE/0020-where-in.mdx
@@ -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!
 

diff --git a/site/docs/examples/WHERE/0030-object-filter.mdx b/site/docs/examples/WHERE/0030-object-filter.mdx
@@ -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!
 

diff --git a/site/docs/examples/WHERE/0040-or-where.mdx b/site/docs/examples/WHERE/0040-or-where.mdx
@@ -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!
 

diff --git a/site/docs/examples/WHERE/0050-conditional-where-calls.mdx b/site/docs/examples/WHERE/0050-conditional-where-calls.mdx
@@ -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!
 

diff --git a/site/docs/examples/WHERE/0060-complex-where-clause.mdx b/site/docs/examples/WHERE/0060-complex-where-clause.mdx
@@ -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!
 

diff --git a/site/docs/examples/transactions/0010-simple-transaction.mdx b/site/docs/examples/transactions/0010-simple-transaction.mdx
@@ -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!
 

diff --git a/site/docs/recipes/0001-relations.md b/site/docs/recipes/0001-relations.md
@@ -97,7 +97,7 @@ These helpers are included in Kysely and you can import them from the `helpers`
 import { jsonArrayFrom, jsonObjectFrom } from 'kysely/helpers/postgres'
 ```
 
-MySQL and SQLite versions of the helpers are slightly different but you can use them the same way. You can import them like this:
+MySQL and SQLite versions of the helpers are slightly different, but you can use them the same way. You can import them like this:
 
 ```ts
 import { jsonArrayFrom, jsonObjectFrom } from 'kysely/helpers/mysql'

diff --git a/site/docs/recipes/0006-expressions.md b/site/docs/recipes/0006-expressions.md
@@ -147,7 +147,7 @@ The above helper is not very type-safe. The following code would compile, but fa
 const bigFatFailure = await db
   .selectFrom('movie') // <-- "person" table is not in context!
   .selectAll('movie')
-  .where(hasDogNamed('Doggo')) // <-- but we're refering to "person.id" in our helper..
+  .where(hasDogNamed('Doggo')) // <-- but we're referring to "person.id" in our helper
   .execute()
 ```
 

diff --git a/src/query-builder/select-query-builder.ts b/src/query-builder/select-query-builder.ts
@@ -286,9 +286,9 @@ export interface SelectQueryBuilder<DB, TB extends keyof DB, O>
    *
    *  <!-- siteExample("select", "Not null", 51) -->
    *
-   * Sometimes you can be sure something's not null but Kysely isn't able to infer
+   * 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
+   * `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`.