Skip to content

Commit d18ce9f

Browse files
caspar-aipmai
authored andcommitted
Tidy up documentation
Based on PR feedback. Signed-off-by: Caspar de Haes <caspar.dehaes@five.ai>
1 parent 2f7654b commit d18ce9f

File tree

2 files changed

+6
-6
lines changed

2 files changed

+6
-6
lines changed

osi_object.proto

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -341,8 +341,8 @@ message MovingObject
341341
// The trajectory that this moving object expects to follow in the future.
342342
//
343343
// This is not externally perceivable information, rather this is to aid
344-
// realistic simulation of agents not under test. This information should
345-
// not be made available to the stack under test.
344+
// realistic simulation of traffic participants not under test. This
345+
// information should not be made available to the stack under test.
346346
//
347347
// \note Moving objects are not required to stick to this trajectory, it is
348348
// indicative, and equivalent to the output of a perception + prediction

osi_trafficupdate.proto

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -40,10 +40,10 @@ message TrafficUpdate
4040

4141
// Updated traffic participant data
4242
//
43-
// \note Only the id, base member (without dimension and base_polygon),
44-
// and the vehicle_classification.light_state members are considered in
45-
// updates, all other members can be left undefined, and will be
46-
// ignored by the receiver of this message.
43+
// \note It is not expected that static fields are populated, and if they
44+
// are they may be ignored by the receiver of this message (e.g. dimensions,
45+
// or vehicle category). All dynamic fields should be populated where known
46+
// for example, velocity, light states, or future trajectory.
4747
//
4848
repeated MovingObject traffic = 3;
4949
}

0 commit comments

Comments
 (0)