Commit 4b7f543
authored
docs: add unit and range documentation to message fields (#107)
* docs: add unit and range documentation to message fields
Add inline comments to clarify units and valid ranges for:
- PedalsCommand.msg: throttle/brake range (0.0-1.0)
- SteeringCommand.msg: steering_tire_angle [rad], velocity [rad/s]
- VelocityFactor.msg: distance [m], field descriptions
Related to #106
* docs: clarify behavior field accepts user-defined values
* Update autoware_adapi_v1_msgs/planning/msg/VelocityFactor.msg1 parent 6c3faf2 commit 4b7f543
3 files changed
Lines changed: 14 additions & 3 deletions
File tree
- autoware_adapi_v1_msgs
- manual/msg
- planning/msg
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | 1 | | |
| 2 | + | |
2 | 3 | | |
| 4 | + | |
3 | 5 | | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | 1 | | |
| 2 | + | |
2 | 3 | | |
| 4 | + | |
3 | 5 | | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
2 | 2 | | |
3 | 3 | | |
4 | 4 | | |
5 | | - | |
6 | | - | |
| 5 | + | |
| 6 | + | |
7 | 7 | | |
8 | | - | |
| 8 | + | |
| 9 | + | |
9 | 10 | | |
| 11 | + | |
10 | 12 | | |
| 13 | + | |
11 | 14 | | |
| 15 | + | |
12 | 16 | | |
| 17 | + | |
13 | 18 | | |
| 19 | + | |
14 | 20 | | |
| 21 | + | |
15 | 22 | | |
0 commit comments