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(behavior_path_planner): update goal planner docs #3690

Merged
merged 12 commits into from
May 15, 2023

Conversation

kosuke55
Copy link
Contributor

@kosuke55 kosuke55 commented May 12, 2023

Description

update goal planner docs

image

🤖 Generated by Copilot at 292c7b8

This pull request improves the documentation of the goal planner module in the behavior path planner package. It explains the roles and interactions of the different submodules and provides visual and textual examples. It also defines the conditions for starting and finishing the goal planning process.

Related links

Tests performed

Notes for reviewers

Interface changes

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.

  • The PR follows the pull request guidelines.
  • The PR has been properly tested.
  • The PR has been reviewed by the code owners.

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.
  • The PR is ready for merge.

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 May 12, 2023
@kosuke55 kosuke55 added run:deploy-docs Mark for deploy-docs action generation. (used-by-ci) and removed type:documentation Creating or refining documentation. (auto-assigned) component:planning Route planning, decision-making, and navigation. (auto-assigned) labels May 12, 2023
@kosuke55 kosuke55 force-pushed the docs/update_goal_planner branch from 1f5514d to 11d0d93 Compare May 12, 2023 09:15
@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 May 12, 2023
Signed-off-by: kosuke55 <kosuke.tnp@gmail.com>
@kosuke55 kosuke55 force-pushed the docs/update_goal_planner branch from 11d0d93 to 1ceb729 Compare May 12, 2023 09:27
@codecov
Copy link

codecov bot commented May 12, 2023

Codecov Report

Patch coverage has no change and project coverage change: -0.02 ⚠️

Comparison is base (81111f8) 14.78% compared to head (11ec297) 14.77%.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #3690      +/-   ##
==========================================
- Coverage   14.78%   14.77%   -0.02%     
==========================================
  Files        1301     1301              
  Lines       92611    93094     +483     
  Branches    29290    29623     +333     
==========================================
+ Hits        13689    13750      +61     
- Misses      64153    64545     +392     
- Partials    14769    14799      +30     
Flag Coverage Δ *Carryforward flag
differential 13.38% <ø> (?)
total 14.78% <ø> (ø) Carriedforward from 4530b31

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

see 6 files with indirect coverage changes

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

Signed-off-by: kosuke55 <kosuke.tnp@gmail.com>
@kosuke55 kosuke55 force-pushed the docs/update_goal_planner branch from 292c7b8 to 37c24de Compare May 12, 2023 10:38
Signed-off-by: kosuke55 <kosuke.tnp@gmail.com>
kosuke55 and others added 3 commits May 13, 2023 14:21
…_planner_design.md

Co-authored-by: Shumpei Wakabayashi <42209144+shmpwk@users.noreply.github.com>
…_planner_design.md

Co-authored-by: Shumpei Wakabayashi <42209144+shmpwk@users.noreply.github.com>
…_planner_design.md

Co-authored-by: Shumpei Wakabayashi <42209144+shmpwk@users.noreply.github.com>
kosuke55 and others added 4 commits May 13, 2023 14:22
…_planner_design.md

Co-authored-by: Shumpei Wakabayashi <42209144+shmpwk@users.noreply.github.com>
…_planner_design.md

Co-authored-by: Shumpei Wakabayashi <42209144+shmpwk@users.noreply.github.com>
…_planner_design.md

Co-authored-by: Shumpei Wakabayashi <42209144+shmpwk@users.noreply.github.com>
…_planner_design.md

Co-authored-by: Shumpei Wakabayashi <42209144+shmpwk@users.noreply.github.com>
@kosuke55 kosuke55 merged commit c2d4bc8 into main May 15, 2023
@kosuke55 kosuke55 deleted the docs/update_goal_planner branch May 15, 2023 01:57
kosuke55 added a commit to tier4/autoware.universe that referenced this pull request May 16, 2023
…tion#3690)

* docs(behavior_path_planner): update goal planner docs

Signed-off-by: kosuke55 <kosuke.tnp@gmail.com>

* update planner manager design

Signed-off-by: kosuke55 <kosuke.tnp@gmail.com>

* fix image

Signed-off-by: kosuke55 <kosuke.tnp@gmail.com>

* Update planning/behavior_path_planner/docs/behavior_path_planner_goal_planner_design.md

Co-authored-by: Shumpei Wakabayashi <42209144+shmpwk@users.noreply.github.com>

* Update planning/behavior_path_planner/docs/behavior_path_planner_goal_planner_design.md

Co-authored-by: Shumpei Wakabayashi <42209144+shmpwk@users.noreply.github.com>

* Update planning/behavior_path_planner/docs/behavior_path_planner_goal_planner_design.md

Co-authored-by: Shumpei Wakabayashi <42209144+shmpwk@users.noreply.github.com>

* Update planning/behavior_path_planner/docs/behavior_path_planner_goal_planner_design.md

Co-authored-by: Shumpei Wakabayashi <42209144+shmpwk@users.noreply.github.com>

* Update planning/behavior_path_planner/docs/behavior_path_planner_goal_planner_design.md

Co-authored-by: Shumpei Wakabayashi <42209144+shmpwk@users.noreply.github.com>

* Update planning/behavior_path_planner/docs/behavior_path_planner_goal_planner_design.md

Co-authored-by: Shumpei Wakabayashi <42209144+shmpwk@users.noreply.github.com>

* Update planning/behavior_path_planner/docs/behavior_path_planner_goal_planner_design.md

Co-authored-by: Shumpei Wakabayashi <42209144+shmpwk@users.noreply.github.com>

* Update planning/behavior_path_planner/docs/behavior_path_planner_goal_planner_design.md

* Update planning/behavior_path_planner/docs/behavior_path_planner_goal_planner_design.md

---------

Signed-off-by: kosuke55 <kosuke.tnp@gmail.com>
Co-authored-by: Shumpei Wakabayashi <42209144+shmpwk@users.noreply.github.com>
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) run: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.

3 participants