From 8ca7813a4a69bfc597fa684cd5c31210a427bc4c Mon Sep 17 00:00:00 2001 From: silverqx Date: Sat, 15 Jul 2023 14:14:41 +0200 Subject: [PATCH] docs fixtypo C++ --- docs/README.mdx | 6 +++--- docs/building/migrations.mdx | 4 ++-- docs/building/tinyorm.mdx | 6 +++--- docs/database/migrations.mdx | 2 +- docs/dependencies.mdx | 4 ++-- docs/supported-compilers.mdx | 2 +- docs/tinyorm/getting-started.mdx | 4 ++-- 7 files changed, 14 insertions(+), 14 deletions(-) diff --git a/docs/README.mdx b/docs/README.mdx index fed37ed8a..4be0bc5ef 100644 --- a/docs/README.mdx +++ b/docs/README.mdx @@ -3,15 +3,15 @@ sidebar_position: 0 sidebar_label: 🔥 Prologue slug: / hide_table_of_contents: true -description: TinyORM is a modern c++ ORM library that makes interacting with a database extremely simple. It depends on the QtCore and QtSql libraries. The code is written in the modern c++20 way and is heavily tested with unit and functional tests. +description: TinyORM is a modern C++ ORM library that makes interacting with a database extremely simple. It depends on the QtCore and QtSql libraries. The code is written in the modern C++20 way and is heavily tested with unit and functional tests. keywords: [c++ orm, prologue, tinyorm] --- # Prologue -TinyORM is a modern c++ ORM library that makes interacting with a database extremely simple. It depends on the `QtCore` and `QtSql` libraries. +TinyORM is a modern C++ ORM library that makes interacting with a database extremely simple. It depends on the `QtCore` and `QtSql` libraries. -The code is written in the modern c++20 way and is __heavily__ tested with unit and functional tests. Almost all the query builder methods are unit tested. The TinyORM's query builder code and the code which is responsible for obtaining relationships, is tested by functional tests against all supported databases. The code coverage is good enough to guarantee API and behavior compatibility. +The code is written in the modern C++20 way and is __heavily__ tested with unit and functional tests. Almost all the query builder methods are unit tested. The TinyORM's query builder code and the code which is responsible for obtaining relationships, is tested by functional tests against all supported databases. The code coverage is good enough to guarantee API and behavior compatibility. :::tip For a quick look at what's inside, check out the [Features Summary](features-summary.mdx). diff --git a/docs/building/migrations.mdx b/docs/building/migrations.mdx index 70a55a287..43777df0c 100644 --- a/docs/building/migrations.mdx +++ b/docs/building/migrations.mdx @@ -1,7 +1,7 @@ --- sidebar_position: 3 sidebar_label: Migrations -description: How to compile the TinyORM migrations (tom) c++ console application on Windows and Linux. +description: How to compile the TinyORM migrations (tom) C++ console application on Windows and Linux. keywords: [c++ orm, building, migrations, tinyorm] --- @@ -155,7 +155,7 @@ And paste the following code. /*! Build the database manager instance and add a database connection. */ std::shared_ptr setupManager(); - /*! c++ main function. */ + /*! C++ main function. */ int main(int argc, char *argv[]) { try { diff --git a/docs/building/tinyorm.mdx b/docs/building/tinyorm.mdx index b2c54037b..1fcbeb35e 100644 --- a/docs/building/tinyorm.mdx +++ b/docs/building/tinyorm.mdx @@ -2,7 +2,7 @@ sidebar_position: 0 sidebar_label: TinyORM hide_table_of_contents: true -description: How to compile the TinyORM c++ library on Windows and Linux. +description: How to compile the TinyORM C++ library on Windows and Linux. keywords: [c++ orm, building, tinyorm] --- @@ -438,8 +438,8 @@ Important `CMake` options. | Option Name | Default | Description | | ---------------------------------- | ------- | ----------- | | `CMAKE_DISABLE_PRECOMPILE_HEADERS` | `OFF` | Disable precompiled headers. | -| `CMAKE_CXX_COMPILER` | `auto` | The full path to the `c++` compiler. | -| `CMAKE_CXX_COMPILER_LAUNCHER` | `-` | Default compiler launcher to use for the `c++` compiler.
Can be used to enable `ccache`, eg. `ccache.exe` on `MinGW` or `/usr/bin/ccache` on `Linux`. | +| `CMAKE_CXX_COMPILER` | `auto` | The full path to the `C++` compiler. | +| `CMAKE_CXX_COMPILER_LAUNCHER` | `-` | Default compiler launcher to use for the `C++` compiler.
Can be used to enable `ccache`, eg. `ccache.exe` on `MinGW` or `/usr/bin/ccache` on `Linux`. | | `CMAKE_EXPORT_PACKAGE_REGISTRY` | `ON` | Enable the `export(TinyOrm)` command.
`TinyORM` sets this variable to `ON` by default. | | `CMAKE_VERBOSE_MAKEFILE` | `OFF` | Enable verbose output from Makefile builds. | diff --git a/docs/database/migrations.mdx b/docs/database/migrations.mdx index 6b796aac9..2f11ec7b7 100644 --- a/docs/database/migrations.mdx +++ b/docs/database/migrations.mdx @@ -602,7 +602,7 @@ The schema builder blueprint offers a variety of methods that correspond to the :::info -Names of `Char`, `Double`, `Enum`, and `Float` column methods are in the CamelCase format to avoid collisions with c++ keywords. +Names of `Char`, `Double`, `Enum`, and `Float` column methods are in the CamelCase format to avoid collisions with C++ keywords. :::
diff --git a/docs/dependencies.mdx b/docs/dependencies.mdx index ba57ddc46..cd194d933 100644 --- a/docs/dependencies.mdx +++ b/docs/dependencies.mdx @@ -8,12 +8,12 @@ keywords: [c++ orm, dependencies, tinyorm] # Dependencies -The code was developed on MSVC 16.9-16.11, MSVC 17.2-17.5, GCC 10.2-12.2, and Clang 11-16, so may be assumed it will work on future releases of these compilers. Minimum required ISO C++ standard is c++20. +The code was developed on MSVC 16.9-16.11, MSVC 17.2-17.5, GCC 10.2-12.2, and Clang 11-16, so may be assumed it will work on future releases of these compilers. Minimum required ISO C++ standard is C++20. The Qt framework version used during development was 5.15.2 and >=6.2. ##### Required -- minimum ISO C++ standard is c++20 +- minimum ISO C++ standard is C++20 - >= [Qt Framework 5.15.2](https://www.qt.io/download-qt-installer) - [`QtCore`](https://doc.qt.io/qt-5/qtcore-module.html) and [`QtSql`](https://doc.qt.io/qt-5/qtsql-index.html) modules (MSVC 2019 binaries) - >= [Qt Framework 6.2](https://www.qt.io/download-qt-installer) - [`QtCore`](https://doc.qt.io/qt-6/qtcore-module.html) and [`QtSql`](https://doc.qt.io/qt-6/qtsql-index.html) modules (MSVC 2019 binaries) - >= [range-v3 0.11.0](https://github.com/ericniebler/range-v3) diff --git a/docs/supported-compilers.mdx b/docs/supported-compilers.mdx index 6919b5aae..5f505c9ab 100644 --- a/docs/supported-compilers.mdx +++ b/docs/supported-compilers.mdx @@ -2,7 +2,7 @@ sidebar_position: 2 sidebar_label: 🚀 Supported Compilers hide_table_of_contents: true -description: Platform requirements, supported compilers and build systems for TinyORM c++ library. +description: Platform requirements, supported compilers and build systems for TinyORM C++ library. keywords: [c++ orm, supported compilers, supported build systems, tinyorm] --- diff --git a/docs/tinyorm/getting-started.mdx b/docs/tinyorm/getting-started.mdx index 1070c05ae..31e495148 100644 --- a/docs/tinyorm/getting-started.mdx +++ b/docs/tinyorm/getting-started.mdx @@ -579,7 +579,7 @@ Of course, when using TinyORM, we don't only need to retrieve models from the da In this example, we assign the `name` attribute of the `Flight` model instance. When we call the `save` method, a record will be inserted into the database. The model's `created_at` and `updated_at` timestamps will automatically be set when the `save` method is called, so there is no need to set them manually. -Alternatively, you may use the `create` method to "save" a new model using a single c++ statement. The inserted model instance will be returned to you by the `create` method: +Alternatively, you may use the `create` method to "save" a new model using a single C++ statement. The inserted model instance will be returned to you by the `create` method: #include "models/flight.hpp" @@ -660,7 +660,7 @@ The `wasChanged` method determines if any attributes were changed after the mode ### Mass Assignment -You may use the `create` method to "save" a new model using a single c++ statement. The inserted model instance will be returned to you by the method: +You may use the `create` method to "save" a new model using a single C++ statement. The inserted model instance will be returned to you by the method: #include "models/flight.hpp"