Skip to content

Commit 2f317fb

Browse files
committed
fix(docs): Improve text quality (#534)
Signed-off-by: Maximilian Rosin <[email protected]>
1 parent 173842e commit 2f317fb

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

doc/architecture/architecture_overview.adoc

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -26,11 +26,12 @@ image::osi-traffic-participant-advanced.png[1100]
2626
OSI currently provides only limited support for data structures describing measured internal states of the traffic participant.
2727
Actuator intentions are currently not covered by OSI and must be handled with a different data description format.
2828

29-
All fields in an interface are set to optional and required is not used.
30-
This has been done to allow backward compatible changes in the field.
31-
Additionally, this is the default behavior in protobuf version 3 that does no longer have the required type and therefore ensures update compatibility.
29+
All fields in an interface are set to `optional`.
30+
`required` is not used.
31+
This has been done to allow backward-compatible changes in the field.
32+
Additionally, this is the default behavior in Protocol Buffer version 3 that does no longer have the `required` type and therefore ensures update compatibility.
3233
However, this does not mean that filling the field is optional.
3334
For the purpose of providing a complete interface, all existing fields should be set, unless not setting a field carries a specific meaning as indicated in the accompanying comment.
3435

35-
All field numbers of 10000 and upward are available for user-specific extensions via custom fields.
36-
Therefore, no future evolution of OSI will use field numbers of 10000 or above.
36+
All field numbers equal to or greater than 10000 are available for user-specific extensions via custom fields.
37+
Therefore, no future evolution of OSI will use field numbers equal to or greater than 10000.

0 commit comments

Comments
 (0)