Skip to content

Commit 5078a91

Browse files
committed
fix(docs): Align wording across files (#465)
Signed-off-by: Maximilian Rosin <maximilian.rosin@parson-europe.com>
1 parent 12b4574 commit 5078a91

File tree

5 files changed

+13
-9
lines changed

5 files changed

+13
-9
lines changed

osi_lane.proto

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ message Lane
5656
// from one or more objects or external references.
5757
//
5858
// For example, to reference a lane defined in an OpenDRIVE map
59-
// the items should be set as following:
59+
// the items should be set as follows:
6060
// * reference = URI to map, can remain empty if identical with definiton
6161
// in \c GroundTruth::map_reference
6262
// * type = "net.asam.opendrive"

osi_object.proto

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -45,16 +45,18 @@ message StationaryObject
4545
// The external reference points to the source of a stationary object, if it
4646
// is derived from an external sources like OpenDRIVE or OpenSCENARIO.
4747
//
48-
// For OpenDRIVE, references to objects should be set as following:
48+
// For example, to reference an object defined in an OpenDRIVE map
49+
// the items should be set as follows:
4950
// * reference = URI to map, can remain empty if identical with definiton
5051
// in \c GroundTruth::map_reference
5152
// * type = "net.asam.opendrive"
5253
// * identifier[0] = "object" for t_road_objects_object and
5354
// "bridge" for t_road_objects_bridge
5455
// * identifier[1] = id of t_road_objects_object or t_road_objects_bridge
5556
//
56-
// For OpenSCENARIO, references to entities of the type MiscObject, which
57-
// describes partly stationary objects, should be set as following:
57+
// For example, to reference OpenSCENARIO entities of the type MiscObject,
58+
// which describe partly stationary objects, the items should be set as
59+
// follows:
5860
// * reference = URI to the OpenSCENARIO File
5961
// * type = "net.asam.openscenario"
6062
// * identifier[0] = Entity-Type ("MiscObject")
@@ -397,8 +399,9 @@ message MovingObject
397399
// The external reference points to the source of an moving object, if it
398400
// is derived from an external sources like OpenSCENARIO.
399401
//
400-
// For OpenSCENARIO, references to entities of the type Vehicle or
401-
// Pedestrian, which describe moving objects, should be set as following:
402+
// For example, to reference OpenSCENARIO entities of the type Vehicle or
403+
// Pedestrian, which describe moving objects, the items should be set as
404+
// follows:
402405
// * reference = URI to the OpenSCENARIO File
403406
// * type = "net.asam.openscenario"
404407
// * identifier[0] = Entity-Type ("Vehicle" or "Pedestrian")

osi_roadmarking.proto

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,8 @@ message RoadMarking
6161
// is derived from one or more objects or external references. An example
6262
// here is the reference to the signal defined in a OpenDRIVE map.
6363
//
64-
// For OpenDRIVE the items should be set as following:
64+
// For example, to reference a signal defined in an OpenDRIVE map
65+
// the items should be set as follows:
6566
// * reference = URI to map, can remain empty if identical with definiton
6667
// in \c GroundTruth::map_reference
6768
// * type = "net.asam.opendrive"

osi_trafficlight.proto

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ message TrafficLight
4848
// is derived from one or more objects or external references.
4949
//
5050
// For example, to reference a signal defined in an OpenDRIVE map
51-
// the items should be set as following:
51+
// the items should be set as follows:
5252
// * reference = URI to map, can remain empty if identical with definition
5353
// in \c GroundTruth::map_reference
5454
// * type = "net.asam.opendrive"

osi_trafficsign.proto

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -163,7 +163,7 @@ message TrafficSign
163163
// derived from one or more objects or external references.
164164
//
165165
// For example, to reference a signal defined in an OpenDRIVE map
166-
// the items should be set as following:
166+
// the items should be set as follows:
167167
// * reference = URI to map, can remain empty if identical with definition
168168
// in \c GroundTruth::map_reference
169169
// * type = "net.asam.opendrive"

0 commit comments

Comments
 (0)