docs(sensor-models): update and review doc/3_sensor_models#74
Open
shivangi306 wants to merge 1 commit intoShisatoYano:mainfrom
Open
docs(sensor-models): update and review doc/3_sensor_models#74shivangi306 wants to merge 1 commit intoShisatoYano:mainfrom
shivangi306 wants to merge 1 commit intoShisatoYano:mainfrom
Conversation
Sync chapter 3 docs with current sensor source code. Add GNSS and optional UKF extrinsic calibration coverage. Improve English grammar and wording across all 3_sensor_models docs. Refs ShisatoYano#72
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
1 participant
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.
Summary
This PR updates and reviews
doc/3_sensor_modelsto match the latest implementation undersrc/components/sensors, and improves overall English grammar/wording.Before
3_1_obstacle.mdhad outdated wording (e.g., Landmark mention).3_2_lidar.mddid not fully reflect currentSensorParametersbehavior.calculate_sensor_odometry,calibrate_extrinsic_params) was missing in LiDAR update documentation.3_3_sensors.mddescribed olderSensorsAPI (LiDAR-only), while code now supports both LiDAR and GNSS.get_xy_pos_from_gnss()usage were not clearly documented.After
Obstacle,LiDAR, andSensorsdocumentation with current source code.Files Changed
doc/3_sensor_models/3_sensor_models.mddoc/3_sensor_models/3_1_obstacle.mddoc/3_sensor_models/3_2_lidar.mddoc/3_sensor_models/3_3_sensors.mdDiff Stats
Testing