Skip to content

Commit 29a80ef

Browse files
committed
[#1250] Fix review findings in documentation
1 parent d038a95 commit 29a80ef

File tree

2 files changed

+5
-4
lines changed

2 files changed

+5
-4
lines changed

doc/user-documentation/how-to-switch-vocabulary-types-for-iceoryx2-cxx.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,12 +32,13 @@ In addition to use the `std::optional` and `std::expected` with the iceoryx2 C++
3232
bindings, it is also possible to use custom implementations of these types.
3333

3434
> [!NOTE]
35-
> The custom implementations must be API compatible with the STL counterparts.
35+
> The custom implementations must be API compatible with the STL counterparts
36+
> and must not depend on iceoryx2-bb-cxx to avoid a circular dependency!
3637
3738
To integrate the custom vocabulary types into iceoryx2, a CMake target for the
3839
`Expected` and `Optional` must be created.
3940

40-
Please have a look at the
41+
Take a look at the
4142
[custom-vocabulary-types](../../examples/cxx/custom-vocabulary-types) example
4243
as a blueprint to create a CMake package with the required files.
4344

examples/cxx/custom_vocabulary_types/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,9 @@ cmake --build target/ff/cc/custom_vocabulary_types
1515
cmake --install target/ff/cc/custom_vocabulary_types --prefix target/ff/cc/install
1616
```
1717

18-
Now, iceoryx2 needs to be build with the custom vocabulary types:
18+
Now, iceoryx2 needs to be built with the custom vocabulary types:
1919

20-
```
20+
```console
2121
cargo build --package iceoryx2-ffi-c
2222
cmake -S . \
2323
-B target/ff/cc/build \

0 commit comments

Comments
 (0)