Enhance external sensors documentation. #1236
Merged
AtsushiSakai merged 2 commits intoAtsushiSakai:masterfrom Jun 27, 2025
Merged
Enhance external sensors documentation. #1236AtsushiSakai merged 2 commits intoAtsushiSakai:masterfrom
AtsushiSakai merged 2 commits intoAtsushiSakai:masterfrom
Conversation
Contributor
There was a problem hiding this comment.
Pull Request Overview
This pull request enhances the external sensors documentation by replacing placeholder TBD text with detailed descriptions and references.
- Updated the introduction text formatting for clarity
- Replaced the TBD text for Radar Sensors with a detailed explanation
- Added a Wikipedia references section for further reading
Comments suppressed due to low confidence (2)
docs/modules/12_appendix/external_sensors_main.rst:60
- [nitpick] Consider revising the indentation of the nested bullet list under the 'Wikipedia articles' header to ensure proper reStructuredText rendering. Consistent one-level indentation for sub-bullets can improve readability.
- Wikipedia articles:
docs/modules/12_appendix/external_sensors_main.rst:23
- [nitpick] The updated Radar sensor description is clear; consider ensuring similar levels of detail and style consistency across all sensor sections for a uniform documentation style.
Radar measures distances using radio waves, commonly referred to as Radio Detection and Ranging (RADAR). It operates by transmitting radio signals towards an object and calculating the distance based on the time it takes for the reflected waves to return, using the speed of radio waves as a constant.
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.
Reference issue
fix issue #1160: #1160
What does this implement/fix?
Adds basic information about some external sensors which were "TBD" in the document.
Additional information
CheckList