Skip to content

Commit c8d9b03

Browse files
iox-#1295 Rework optional/expected and QoS article
1 parent 3d69e7b commit c8d9b03

File tree

2 files changed

+4
-4
lines changed

2 files changed

+4
-4
lines changed

doc/website/concepts/how-optional-and-error-values-are-returned-in-iceoryx.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ result = iox::nullopt;
6969
```
7070

7171
For a complete list of available functions see
72-
[`optional.hpp`](../../../iceoryx_hoofs/vocabulary/include/iox/optional.hpp).
72+
[`optional.hpp`](https://github.com/eclipse-iceoryx/iceoryx/blob/v3.0.0/iceoryx_hoofs/vocabulary/include/iox/optional.hpp).
7373

7474

7575
## Expected
@@ -80,7 +80,7 @@ the 'either monad'. It is usually used to pass a value of type `T` or an error t
8080
error type.
8181

8282
For more information on how it is used for error handling see
83-
[error-handling.md](../../design/error-handling.md).
83+
[error-handling.md](https://github.com/eclipse-iceoryx/iceoryx/blob/v3.0.0/doc/design/error-handling.md).
8484

8585
Assume we have `E` as an error type, then we can create a value
8686

@@ -121,7 +121,7 @@ result.and_then(handleValue).or_else(handleError);
121121
122122
There are more convenience functions such as `value_or` which provides the value or an alternative specified by the
123123
user. These can be found in
124-
[`expected.hpp`](../../../iceoryx_hoofs/vocabulary/include/iox/expected.hpp).
124+
[`expected.hpp`](https://github.com/eclipse-iceoryx/iceoryx/blob/v3.0.0/iceoryx_hoofs/vocabulary/include/iox/expected.hpp).
125125
126126
Note that when we move an `expected`, the origin contains a moved `T` or `E`, depending on the content before the move.
127127
This reflects the behavior of moving the content out of the `iox::expected` as in

doc/website/concepts/qos-policies.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ The three most important settings are:
5454
2. Multiple publishers after the publisher called `stopOffer()` or is removed
5555
The last n samples will never be received since they vanished. An arbitrary number of samples or nothing is received.
5656

57-
For more information about the options see the corresponding example [`iceoptions`](../../../iceoryx_examples/iceoptions/README.md).
57+
For more information about the options see the corresponding example [`iceoptions`](../examples/iceoptions.md).
5858

5959
!!! info
6060
If the `PublisherOptions::historyCapacity` is larger than `SubscriberOptions::queueCapacity` and blocking behaviour

0 commit comments

Comments
 (0)