Skip to content

Commit 6aef489

Browse files
committed
Fix a couple of typos
1 parent 3e68ead commit 6aef489

File tree

5 files changed

+9
-12
lines changed

5 files changed

+9
-12
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,10 @@ The **text content** is written in the markdown format and the [docs](docs/) fol
88

99
Other resources:
1010

11-
* **Images** are places in the [static/img/assets/](static/img/assets/) folder.
11+
* **Images** are placed in the [static/img/assets/](static/img/assets/) folder.
1212
* The **main navigation** is located in the [sidebars.ts](sidebars.ts) file.
1313
* The main **configuration** is done in the [docusaurus.config.ts](docusaurus.config.ts) file.
14-
* CSS styles are written in the [src/css/custom.css](src/css/custom.css) file.
14+
* Custom **CSS styles** to overwrite the theme's default are located in the [src/css/custom.css](src/css/custom.css) file.
1515

1616
Notes regarding image file names: only use lowercase and no spaces.
1717

docs/README.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ This is the ObjectBox documentation for our C and C++ APIs. We strive to provide
3636
Jobs: We're looking for a [C++ Developer](https://objectbox.io/jobs/objectbox-senior-c-plusplus-developer/) with a ❤️ for performant code
3737
:::
3838

39-
Are you ready use ObjectBox? These two pages will get you up to speed:
39+
Are you ready to use ObjectBox? These two pages will get you up to speed:
4040

4141
<div className="custom-nav-card">
4242
<a href="/installation" className="custom-nav-card-link">

docs/generator.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ This is the reference guide on the ObjectBox Generator, a build-time tool for Ob
3636
For an intro to the generator, see also the [installation guide](installation#objectbox-generator) and [Generating Binding Code](getting-started#generating-binding-code).
3737
:::
3838

39-
When using ObjectBox within your project, you typically need two things: the runtime library and the the build-time ObjectBox Generator. The generator takes a data model (see [Entity Annotations](entity-annotations)) as input and generates `struct`s, a data model representation as code and additional glue code for a tight and fast integration of your individual data types and the ObjectBox API.
39+
When using ObjectBox within your project, you typically need two things: the runtime library and the build-time ObjectBox Generator. The generator takes a data model (see [Entity Annotations](entity-annotations)) as input and generates `struct`s, a data model representation as code and additional glue code for a tight and fast integration of your individual data types and the ObjectBox API.
4040

4141
If you are using CMake, it's highly recommended to use the CMake integration of the ObjectBox Generator. For all other setups, triggering the generator in [standalone mode](generator#using-the-standalone-generator) is also supported.
4242

@@ -57,7 +57,7 @@ Once you have the ObjectBox runtime library set up via `FetchContent` (see [inst
5757
find_package(ObjectBoxGenerator 4.0.0 REQUIRED)
5858
```
5959

60-
With that, the CMake funciton add\_obx\_schema is now available (see next section).
60+
With that, the CMake function add\_obx\_schema is now available (see next section).
6161

6262
### Add the schema with `add_obx_schema`
6363

docs/installation.mdx

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ endif()
9191
9292
add_executable(myapp main.cpp)
9393
target_link_libraries(myapp objectbox)
94-
```cmake
94+
```
9595
If you want to integrate the ObjectBox-Generator via CMake (as an alternative to offline installation and pre-generation of C++ sources), use the following snippet:
9696

9797
```cmake
@@ -105,9 +105,8 @@ add_obx_schema(
105105
INSOURCE # Opt-in: Generate in source directory
106106
CXX_STANDARD 11 # Defaults to C++14 otherwise
107107
)
108-
```cmake
109-
\
110-
If you want to use an ObjectBox Sync variant of the library, change the list line to:&#x20;
108+
```
109+
If you want to use an ObjectBox Sync variant of the library, change the `target_link_libraries` to:&#x20;
111110

112111
```cmake title="CMakeLists.txt"
113112
target_link_libraries(myapp objectbox-sync)

docs/store.mdx

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ obx_store_open(opt);
9797
Available since v0.21.0
9898
:::
9999

100-
You can use ObjectBox alsofor non-persistent in-memory databases. To create a memory-backed store, use the directory prefix "`memory:`" and pick a name for the database to address it, e.g. “memory:myApp”. Apart from the special prefix, it's using the same "directory" option call:
100+
You can use ObjectBox also for non-persistent in-memory databases. To create a memory-backed store, use the directory prefix "`memory:`" and pick a name for the database to address it, e.g. “memory:myApp”. Apart from the special prefix, it's using the same "directory" option call:
101101

102102
<Tabs>
103103
<TabItem value="cpp" label="C++">
@@ -355,5 +355,3 @@ Once you created the store, it gives you access to several ways to interact with
355355
* [**Box API**](getting-started#working-with-object-boxes)**:** easy to use object-based API with implicit transactions. It is used in combination with the ObjectBox Generator, which generates the source code for data and Box classes. Check the getting started track for examples.
356356
* [**Query API**](queries)**:** In combination with the Box API, you can build powerful queries using the query builder. Once built, query instances can be executed multiple times to retrieve data.&#x20;
357357
* [**Explicit Transactions**](transactions)**:** Often it's a good idea to group several operations into a single "batch", or more precisely, one transaction. Batched transactions are not only faster, but also consider safe state changes for your data.
358-
359-

0 commit comments

Comments
 (0)