Skip to content

Commit

Permalink
docs: Fix some tiny typos
Browse files Browse the repository at this point in the history
Signed-off-by: Christian Parpart <[email protected]>
  • Loading branch information
christianparpart committed Jan 17, 2025
1 parent 275abda commit 7eb222b
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 5 deletions.
2 changes: 1 addition & 1 deletion docs/best-practices.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/sqlquery.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`
Expand Down
6 changes: 3 additions & 3 deletions docs/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ while (cursor.FetchRow())
## SQL Query Builder
Or constuct statement using `SqlQueryBuilder`
Or construct statement using `SqlQueryBuilder`
```cpp
auto stmt = SqlStatement { };
Expand Down Expand Up @@ -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
Expand Down

0 comments on commit 7eb222b

Please sign in to comment.