Skip to content
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

docs(avoidance): update parameter names #4294

Merged

Conversation

satoshi-ota
Copy link
Contributor

@satoshi-ota satoshi-ota commented Jul 17, 2023

Description

🤖 Generated by Copilot at 280b6f6

This pull request improves the avoidance module of the behavior path planner by adding new features, parameters, and documentation. It renames two parameters, enable_avoidance_over_same_direction and enable_avoidance_over_opposite_direction, to use_adjacent_lane and use_opposite_lane, to make them more descriptive and clear. It also updates the avoidance.param.yaml file, the behavior_path_planner_avoidance_design.md file, and several source files to reflect the changes.

Please approve ⬇️ before this PR.
autowarefoundation/autoware_launch#453

Tests performed

Not applicable.

Effects on system behavior

Not applicable.

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.

  • There are no open discussions or they are tracked via tickets.

After all checkboxes are checked, anyone who has write access can merge the PR.

@github-actions github-actions bot added type:documentation Creating or refining documentation. (auto-assigned) component:planning Route planning, decision-making, and navigation. (auto-assigned) labels Jul 17, 2023
@satoshi-ota satoshi-ota added tag:deploy-docs Mark for deploy-docs action generation. (used-by-ci) and removed component:planning Route planning, decision-making, and navigation. (auto-assigned) labels Jul 17, 2023
@github-actions github-actions bot added the component:planning Route planning, decision-making, and navigation. (auto-assigned) label Jul 17, 2023
@codecov
Copy link

codecov bot commented Jul 17, 2023

Codecov Report

Patch and project coverage have no change.

Comparison is base (f6b14ec) 14.18% compared to head (280b6f6) 14.18%.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #4294   +/-   ##
=======================================
  Coverage   14.18%   14.18%           
=======================================
  Files        1599     1599           
  Lines      110050   110045    -5     
  Branches    31539    31534    -5     
=======================================
  Hits        15612    15612           
+ Misses      77486    77482    -4     
+ Partials    16952    16951    -1     
Flag Coverage Δ *Carryforward flag
differential 13.59% <0.00%> (?)
total 14.18% <ø> (+<0.01%) ⬆️ Carriedforward from f6b14ec

*This pull request uses carry forward flags. Click here to find out more.

Impacted Files Coverage Δ
..._planner/utils/avoidance/avoidance_module_data.hpp 0.00% <ø> (ø)
...er/src/scene_module/avoidance/avoidance_module.cpp 11.54% <0.00%> (ø)
...ath_planner/src/scene_module/avoidance/manager.cpp 7.42% <0.00%> (+0.03%) ⬆️
...h_planner/src/scene_module/lane_change/manager.cpp 7.05% <ø> (+0.17%) ⬆️
...ehavior_path_planner/src/utils/avoidance/utils.cpp 6.13% <0.00%> (ø)

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

@satoshi-ota satoshi-ota marked this pull request as ready for review July 17, 2023 23:09
@satoshi-ota satoshi-ota changed the title refactor(avoidance): update parameter names docs(avoidance): update parameter names Jul 17, 2023
@satoshi-ota satoshi-ota merged commit 2dbb2a6 into autowarefoundation:main Jul 18, 2023
33 of 36 checks passed
@satoshi-ota satoshi-ota deleted the refactor/rename-params branch July 18, 2023 02:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component:planning Route planning, decision-making, and navigation. (auto-assigned) tag:deploy-docs Mark for deploy-docs action generation. (used-by-ci) type:documentation Creating or refining documentation. (auto-assigned)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants