Repository navigation
docs: clarify that Obstacle length_m is half the longitudinal size - #213
Open
HarshRajSinghania wants to merge 1 commit into
Open
HarshRajSinghania wants to merge 1 commit into
HarshRajSinghania wants to merge 1 commit into
Conversation
Fixes ShisatoYano#212. The constructor docstring for length_m previously described it as the full longitudinal size, but the outline is built from ±length_m, matching the half-size semantics already documented for width_m. No behavior change.
This branch has not been deployed
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.
Summary
Updates the constructor docstring in
src/components/obstacle/obstacle.pyso thatlength_mis correctly described as half the obstacle's longitudinal size, matching the existing description forwidth_mand the actual contour construction (±length_m).Motivation
Fixes #212. The previous docstring claimed
length_mwas the full longitudinal size, which is inconsistent with how the outline is built and with the half-size semantics already documented forwidth_m. Example usage indoc/sensors/visualize_obstacle.pyproduces a rectangle twice the size of the documented parameters.Implementation
length_mparameter description in the__init__docstring from "Obstacle's longitudinal size[m]" to "Half of the obstacle's longitudinal size[m]".Testing
±length_m/±width_mas before.Closes #212.