From c65e5b352e815b1ffd317ce6df3c98af8c54ae99 Mon Sep 17 00:00:00 2001 From: Anthony DePasquale Date: Fri, 26 Apr 2024 20:52:13 +0200 Subject: [PATCH] Fix punctuation and spelling --- README.md | 2 +- scripts/generate-site-examples.js | 2 +- site/docs/examples/DELETE/0010-single-row.mdx | 2 +- site/docs/examples/INSERT/0010-single-row.mdx | 2 +- site/docs/examples/INSERT/0020-multiple-rows.mdx | 2 +- site/docs/examples/INSERT/0030-returning-data.mdx | 2 +- site/docs/examples/INSERT/0040-complex-values.mdx | 2 +- site/docs/examples/INSERT/0050-insert-subquery.mdx | 2 +- site/docs/examples/JOIN/0010-simple-inner-join.mdx | 2 +- site/docs/examples/JOIN/0020-aliased-inner-join.mdx | 2 +- site/docs/examples/JOIN/0030-complex-join.mdx | 2 +- site/docs/examples/JOIN/0040-subquery-join.mdx | 2 +- site/docs/examples/SELECT/0010-a-single-column.mdx | 2 +- site/docs/examples/SELECT/0020-column-with-a-table.mdx | 2 +- site/docs/examples/SELECT/0030-multiple-columns.mdx | 2 +- site/docs/examples/SELECT/0040-aliases.mdx | 2 +- site/docs/examples/SELECT/0050-complex-selections.mdx | 2 +- site/docs/examples/SELECT/0051-not-null.mdx | 6 +++--- site/docs/examples/SELECT/0060-function-calls.mdx | 2 +- site/docs/examples/SELECT/0070-distinct.mdx | 2 +- site/docs/examples/SELECT/0080-distinct-on.mdx | 2 +- site/docs/examples/SELECT/0090-all-columns.mdx | 2 +- site/docs/examples/SELECT/0100-all-columns-of-a-table.mdx | 2 +- site/docs/examples/SELECT/0110-nested-array.mdx | 2 +- site/docs/examples/SELECT/0120-nested-object.mdx | 2 +- site/docs/examples/UPDATE/0010-single-row.mdx | 2 +- site/docs/examples/UPDATE/0020-complex-values.mdx | 2 +- site/docs/examples/WHERE/0010-simple-where-clause.mdx | 2 +- site/docs/examples/WHERE/0020-where-in.mdx | 2 +- site/docs/examples/WHERE/0030-object-filter.mdx | 2 +- site/docs/examples/WHERE/0040-or-where.mdx | 2 +- site/docs/examples/WHERE/0050-conditional-where-calls.mdx | 2 +- site/docs/examples/WHERE/0060-complex-where-clause.mdx | 2 +- site/docs/examples/transactions/0010-simple-transaction.mdx | 2 +- site/docs/recipes/0001-relations.md | 2 +- site/docs/recipes/0006-expressions.md | 2 +- src/query-builder/select-query-builder.ts | 4 ++-- 37 files changed, 40 insertions(+), 40 deletions(-) diff --git a/README.md b/README.md index 9181c4419..6831a7910 100644 --- 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 index b20244087..c72ccb348 100644 --- 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 index 922cf9678..eb5f6ee43 100644 --- a/site/docs/examples/DELETE/0010-single-row.mdx +++ b/site/docs/examples/DELETE/0010-single-row.mdx @@ -20,7 +20,7 @@ import { :::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 index b5085b83a..422e41b45 100644 --- a/site/docs/examples/INSERT/0010-single-row.mdx +++ b/site/docs/examples/INSERT/0010-single-row.mdx @@ -20,7 +20,7 @@ import { :::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 index c8a638778..817660dbb 100644 --- a/site/docs/examples/INSERT/0020-multiple-rows.mdx +++ b/site/docs/examples/INSERT/0020-multiple-rows.mdx @@ -23,7 +23,7 @@ import { :::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 index 5ad8f6cee..a7bf0eaff 100644 --- a/site/docs/examples/INSERT/0030-returning-data.mdx +++ b/site/docs/examples/INSERT/0030-returning-data.mdx @@ -23,7 +23,7 @@ import { :::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 index 9fd9ccd9f..6b1143df6 100644 --- a/site/docs/examples/INSERT/0040-complex-values.mdx +++ b/site/docs/examples/INSERT/0040-complex-values.mdx @@ -22,7 +22,7 @@ import { :::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 index c8db4687f..3d12b1f72 100644 --- a/site/docs/examples/INSERT/0050-insert-subquery.mdx +++ b/site/docs/examples/INSERT/0050-insert-subquery.mdx @@ -22,7 +22,7 @@ import { :::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 index 17ce8e62e..59ff6fe98 100644 --- 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 { :::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 index a16d0fb25..ffed6eb9a 100644 --- 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 { :::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 index 564277e82..7c63dd7c2 100644 --- a/site/docs/examples/JOIN/0030-complex-join.mdx +++ b/site/docs/examples/JOIN/0030-complex-join.mdx @@ -28,7 +28,7 @@ import { :::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 index 2bc1ee0a1..0963ff981 100644 --- a/site/docs/examples/JOIN/0040-subquery-join.mdx +++ b/site/docs/examples/JOIN/0040-subquery-join.mdx @@ -20,7 +20,7 @@ import { :::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 index 005bd0771..4c97ce659 100644 --- 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 { :::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 index 9035e2344..40d033c85 100644 --- 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 { :::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 index 45cfebb64..b8d53f51d 100644 --- a/site/docs/examples/SELECT/0030-multiple-columns.mdx +++ b/site/docs/examples/SELECT/0030-multiple-columns.mdx @@ -20,7 +20,7 @@ import { :::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 index 980b20282..ee64e1774 100644 --- a/site/docs/examples/SELECT/0040-aliases.mdx +++ b/site/docs/examples/SELECT/0040-aliases.mdx @@ -20,7 +20,7 @@ import { :::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 index 4714a0a68..786ffb5cc 100644 --- a/site/docs/examples/SELECT/0050-complex-selections.mdx +++ b/site/docs/examples/SELECT/0050-complex-selections.mdx @@ -21,7 +21,7 @@ import { :::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 index 528856ddb..15ad39fde 100644 --- 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 { :::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 index b5b82bc32..1ce3bc0f6 100644 --- a/site/docs/examples/SELECT/0060-function-calls.mdx +++ b/site/docs/examples/SELECT/0060-function-calls.mdx @@ -22,7 +22,7 @@ import { :::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 index 2b834d286..5b3c98aea 100644 --- a/site/docs/examples/SELECT/0070-distinct.mdx +++ b/site/docs/examples/SELECT/0070-distinct.mdx @@ -20,7 +20,7 @@ import { :::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 index eddcd673f..5fe2a69ac 100644 --- a/site/docs/examples/SELECT/0080-distinct-on.mdx +++ b/site/docs/examples/SELECT/0080-distinct-on.mdx @@ -18,7 +18,7 @@ import { :::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 index a9e40d313..4125695c7 100644 --- a/site/docs/examples/SELECT/0090-all-columns.mdx +++ b/site/docs/examples/SELECT/0090-all-columns.mdx @@ -20,7 +20,7 @@ import { :::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 index c614c7178..809e39fb8 100644 --- 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 { :::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 index 6253077e5..628bbe12c 100644 --- a/site/docs/examples/SELECT/0110-nested-array.mdx +++ b/site/docs/examples/SELECT/0110-nested-array.mdx @@ -29,7 +29,7 @@ import { :::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 index 052e9520d..d4c47394e 100644 --- a/site/docs/examples/SELECT/0120-nested-object.mdx +++ b/site/docs/examples/SELECT/0120-nested-object.mdx @@ -29,7 +29,7 @@ import { :::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 index cf478cf32..a70b9e13d 100644 --- a/site/docs/examples/UPDATE/0010-single-row.mdx +++ b/site/docs/examples/UPDATE/0010-single-row.mdx @@ -20,7 +20,7 @@ import { :::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 index 0af4af00a..c1eedb3ce 100644 --- a/site/docs/examples/UPDATE/0020-complex-values.mdx +++ b/site/docs/examples/UPDATE/0020-complex-values.mdx @@ -21,7 +21,7 @@ import { :::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 index b3e8a7911..5511332ec 100644 --- 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 { :::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 index ece41d1dd..9ccfa561b 100644 --- a/site/docs/examples/WHERE/0020-where-in.mdx +++ b/site/docs/examples/WHERE/0020-where-in.mdx @@ -20,7 +20,7 @@ import { :::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 index 0236dde6c..87c9bf62a 100644 --- a/site/docs/examples/WHERE/0030-object-filter.mdx +++ b/site/docs/examples/WHERE/0030-object-filter.mdx @@ -21,7 +21,7 @@ import { :::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 index 34f5c4209..842cc0b17 100644 --- a/site/docs/examples/WHERE/0040-or-where.mdx +++ b/site/docs/examples/WHERE/0040-or-where.mdx @@ -22,7 +22,7 @@ import { :::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 index 441ba3e11..02d531d0a 100644 --- 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 { :::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 index 876d9aa54..410f7479b 100644 --- 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 { :::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 index 514b1dc07..7262c1c74 100644 --- a/site/docs/examples/transactions/0010-simple-transaction.mdx +++ b/site/docs/examples/transactions/0010-simple-transaction.mdx @@ -22,7 +22,7 @@ import { :::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 index fbb2eaf18..f3e55336c 100644 --- 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 index b9dbaabcb..4e3ec0634 100644 --- 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 index f06081212..dd1312314 100644 --- a/src/query-builder/select-query-builder.ts +++ b/src/query-builder/select-query-builder.ts @@ -286,9 +286,9 @@ export interface SelectQueryBuilder * * * - * 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`.