docs(behavior_path_planner): add documentation for avoidance by lane change module #4087
Conversation
This file contains 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
|
Documentation URL: https://autowarefoundation.github.io/autoware.universe/pr-4087/ |
…change module Signed-off-by: satoshi-ota <satoshi.ota928@gmail.com>
7817db2 to
2b4d81f
Compare
Codecov ReportPatch and project coverage have no change.
Additional details and impacted files@@ Coverage Diff @@
## main #4087 +/- ##
=======================================
Coverage 15.29% 15.29%
=======================================
Files 1461 1461
Lines 101215 101215
Branches 31215 31215
=======================================
Hits 15482 15482
Misses 68897 68897
Partials 16836 16836
*This pull request uses carry forward flags. Click here to find out more. ☔ View full report in Codecov by Sentry. |
tkimura4
reviewed
Jun 27, 2023
| | Name | Unit | Type | Description | Default value | | ||
| | :------------------------------------------------- | ---- | ------ | ---------------------------------------------------------------------------------------------------------------------------------------- | ------------- | | ||
| | execute_object_num | [-] | int | Number of avoidance target objects on ego driving lane is greater than this value, this module will be launched. | 1 | | ||
| | execute_object_longitudinal_margin | [m] | double | [maybe unused] Only when distance between the ego and avoidance target object is longer than this value, this module will be launched. | 0.0 | |
There was a problem hiding this comment.
[maybe unused] <- Is this intentional?
There was a problem hiding this comment.
Is this intentional?
Yes. But I'll remove this parameter.
tkimura4
approved these changes
Jun 27, 2023
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 documentation for avoidance by lane change module.
Tests performed
Nothing.
Effects on system behavior
Nothing.
Pre-review checklist for the PR author
The PR author must check the checkboxes below when creating the PR.
In-review checklist for the PR reviewers
The PR reviewers must check the checkboxes below before approval.
Post-review checklist for the PR author
The PR author must check the checkboxes below before merging.
After all checkboxes are checked, anyone who has write access can merge the PR.