Skip to content

Enhance external sensors documentation. #1236

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

Viralpanchal7899
Copy link

@Viralpanchal7899 Viralpanchal7899 commented Jun 15, 2025

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

  • Did you add an unittest for your new example or defect fix?
  • Did you add documents for your new example?
  • All CIs are green? (You can check it after submitting)

@AtsushiSakai AtsushiSakai reopened this Jun 21, 2025
@AtsushiSakai AtsushiSakai requested a review from Copilot June 21, 2025 10:04
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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. 

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants