docs: add unit and range documentation to message fields#107
Merged
Conversation
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
|
Thank you for contributing to the Autoware project! 🚧 If your pull request is in progress, switch it to draft mode. Please ensure:
|
There was a problem hiding this comment.
Pull request overview
This PR adds inline documentation to message fields across three ROS message definitions to improve clarity on units, valid ranges, and field purposes.
- Added unit and range specifications to command and planning message fields
- Enhanced field descriptions with contextual information and references
- Improved constant documentation with behavior descriptions
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| autoware_adapi_v1_msgs/planning/msg/VelocityFactor.msg | Added comprehensive field documentation including units [m] for distance, descriptions for each field, and clarified status constants |
| autoware_adapi_v1_msgs/manual/msg/SteeringCommand.msg | Documented steering angle unit [rad], angular velocity unit [rad/s], and direction convention (positive=left, negative=right) |
| autoware_adapi_v1_msgs/manual/msg/PedalsCommand.msg | Documented normalized range (0.0-1.0) for throttle and brake pedal positions |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
mitsudome-r
approved these changes
Dec 17, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Add inline comments to message fields to clarify units, ranges, and valid values.
Changes:
PedalsCommand.msg: Document throttle/brake range (0.0-1.0 normalized)SteeringCommand.msg: Document steering_tire_angle [rad] and velocity [rad/s]VelocityFactor.msg: Document distance [m] and add field descriptionsRelated to #106
How was this PR tested?
Message definition changes are documentation-only (comments). No functional changes.
Notes for reviewers
None.
Effects on system behavior
None.