From 7eb222b1e989d2cb36ddbe674d7d48e381e4e1d7 Mon Sep 17 00:00:00 2001 From: Christian Parpart Date: Fri, 17 Jan 2025 23:13:15 +0100 Subject: [PATCH] docs: Fix some tiny typos Signed-off-by: Christian Parpart --- docs/best-practices.md | 2 +- docs/sqlquery.md | 2 +- docs/usage.md | 6 +++--- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/best-practices.md b/docs/best-practices.md index 2754e5c8..29f1cbfe 100644 --- a/docs/best-practices.md +++ b/docs/best-practices.md @@ -18,7 +18,7 @@ while retaining performance and flexibility. Keep the data model and business logic separate to improve the maintainability and scalability of your application. -Remmber to also keep frontend (e.g. GUI) and backend (e.g. API) separate. +Remember to also keep frontend (e.g. GUI) and backend (e.g. API) separate. ## SQL driver related best practices diff --git a/docs/sqlquery.md b/docs/sqlquery.md index 1a58a788..b55b828d 100644 --- a/docs/sqlquery.md +++ b/docs/sqlquery.md @@ -9,7 +9,7 @@ To create a database you need to use `Migration()` function provided by the `Sql Following calls can be chained, for example `CreateTable("test").Column(first).Column(second)...` Available functions: - `PrimaryKey(std::string columnName, SqlColumnTypeDefinition columnType)` - + create primary key colunm in the database, defined by name and type. + + create primary key column in the database, defined by name and type. - `PrimaryKeyWithAutoIncrement( std::string columnName, SqlColumnTypeDefinition columnType )` + create primary key column in the database with automatic indexing + Second parameter has a default value `SqlColumnTypeDefinitions::Bigint` diff --git a/docs/usage.md b/docs/usage.md index 78859c1b..f3b2400c 100644 --- a/docs/usage.md +++ b/docs/usage.md @@ -52,7 +52,7 @@ while (cursor.FetchRow()) ## SQL Query Builder -Or constuct statement using `SqlQueryBuilder` +Or construct statement using `SqlQueryBuilder` ```cpp auto stmt = SqlStatement { }; @@ -129,9 +129,9 @@ void CRUD(DataMapper& dm) ## Simple row retrieval via structs -When only read access is needed, you can use a simple struct to represent the row, +When only read access is needed, you can use a simple `struct` to represent the row, and also do not need to wrap the fields into `Field<>` template. -The struct must have fields that match the columns in the query. The fields can be of any type that can be converted from the column type. The struct can have more fields than the columns in the query, but the fields that match the columns must be in the same order as the columns in the query. +The `struct` must have fields that match the columns in the query. The fields can be of any type that can be converted from the column type. The struct can have more fields than the columns in the query, but the fields that match the columns must be in the same order as the columns in the query. ```cpp struct SimpleStruct