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(trajectory_follower, trajectory_follower_nodes): update docs #1591

Merged
merged 5 commits into from
Aug 29, 2022

Conversation

kosuke55
Copy link
Contributor

@kosuke55 kosuke55 commented Aug 15, 2022

Description

update docs related to #901

Related links

Tests performed

Notes for reviewers

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.

@kosuke55 kosuke55 marked this pull request as ready for review August 15, 2022 15:29
@kosuke55 kosuke55 force-pushed the docs/update_control_docs branch from 3baf1ec to 660936c Compare August 15, 2022 15:30
@kosuke55 kosuke55 added the type:documentation Creating or refining documentation. (auto-assigned) label Aug 15, 2022
@kosuke55 kosuke55 force-pushed the docs/update_control_docs branch 2 times, most recently from e01b930 to cf77546 Compare August 15, 2022 15:36
@codecov
Copy link

codecov bot commented Aug 15, 2022

Codecov Report

Merging #1591 (5d44749) into main (6d669de) will increase coverage by 1.18%.
The diff coverage is n/a.

❗ Current head 5d44749 differs from pull request most recent head 4c48a75. Consider uploading reports for the commit 4c48a75 to get more accurate results

@@            Coverage Diff            @@
##            main    #1591      +/-   ##
=========================================
+ Coverage   9.90%   11.09%   +1.18%     
=========================================
  Files       1195     1111      -84     
  Lines      77392    81370    +3978     
  Branches   18206    20310    +2104     
=========================================
+ Hits        7669     9030    +1361     
- Misses     61058    63163    +2105     
- Partials    8665     9177     +512     
Flag Coverage Δ *Carryforward flag
differential 11.54% <ø> (?)
total 10.76% <ø> (+0.85%) ⬆️ Carriedforward from b6d88ea

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

Impacted Files Coverage Δ
...lude/freespace_planning_algorithms/reeds_shepp.hpp 50.00% <0.00%> (-50.00%) ⬇️
...tic_evaluator/include/kinematic_evaluator/stat.hpp 62.50% <0.00%> (-19.32%) ⬇️
..._evaluator/include/localization_evaluator/stat.hpp 56.25% <0.00%> (-16.48%) ⬇️
.../src/vehicle/test_vehicle_state_checker_helper.hpp 70.58% <0.00%> (-9.42%) ⬇️
planning/behavior_path_planner/test/input.cpp 60.00% <0.00%> (-7.86%) ⬇️
common/perception_utils/src/perception_utils.cpp 56.75% <0.00%> (-6.88%) ⬇️
...include/motion_utils/trajectory/tmp_conversion.hpp 60.00% <0.00%> (-6.67%) ⬇️
...oware_auto_geometry/include/geometry/common_2d.hpp 82.66% <0.00%> (-5.91%) ⬇️
...nning/behavior_velocity_planner/test/src/utils.hpp 82.22% <0.00%> (-5.59%) ⬇️
...tor/kinematic_evaluator/src/metrics_calculator.cpp 37.50% <0.00%> (-5.36%) ⬇️
... and 857 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

@kosuke55 kosuke55 force-pushed the docs/update_control_docs branch from 33e9bda to 39c44df Compare August 15, 2022 15:47
@TakaHoribe TakaHoribe self-requested a review August 29, 2022 07:50
Copy link
Contributor

@TakaHoribe TakaHoribe left a comment

Choose a reason for hiding this comment

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

LGTM! Nice work!

kosuke55 and others added 5 commits August 29, 2022 17:20
Signed-off-by: kosuke55 <kosuke.tnp@gmail.com>
Signed-off-by: kosuke55 <kosuke.tnp@gmail.com>
Signed-off-by: kosuke55 <kosuke.tnp@gmail.com>
Signed-off-by: kosuke55 <kosuke.tnp@gmail.com>
Signed-off-by: Takamasa Horibe <horibe.takamasa@gmail.com>
@kosuke55 kosuke55 force-pushed the docs/update_control_docs branch from 5cdadaf to 4c48a75 Compare August 29, 2022 08:22
@kosuke55 kosuke55 merged commit 96acefc into autowarefoundation:main Aug 29, 2022
@kosuke55 kosuke55 deleted the docs/update_control_docs branch August 29, 2022 11:54
boyali referenced this pull request in boyali/autoware.universe Sep 28, 2022
…er4#1591)

* docs(trajectory_follower, trajectory_follower_nodes): update docs

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

* remove auto issue link

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

* correct sentences

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

* add example of keep stopped

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

* update controller class diagram

Signed-off-by: Takamasa Horibe <horibe.takamasa@gmail.com>

Signed-off-by: kosuke55 <kosuke.tnp@gmail.com>
Signed-off-by: Takamasa Horibe <horibe.takamasa@gmail.com>
Co-authored-by: Takamasa Horibe <horibe.takamasa@gmail.com>
boyali referenced this pull request in boyali/autoware.universe Oct 3, 2022
…er4#1591)

* docs(trajectory_follower, trajectory_follower_nodes): update docs

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

* remove auto issue link

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

* correct sentences

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

* add example of keep stopped

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

* update controller class diagram

Signed-off-by: Takamasa Horibe <horibe.takamasa@gmail.com>

Signed-off-by: kosuke55 <kosuke.tnp@gmail.com>
Signed-off-by: Takamasa Horibe <horibe.takamasa@gmail.com>
Co-authored-by: Takamasa Horibe <horibe.takamasa@gmail.com>
boyali referenced this pull request in boyali/autoware.universe Oct 3, 2022
…er4#1591)

* docs(trajectory_follower, trajectory_follower_nodes): update docs

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

* remove auto issue link

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

* correct sentences

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

* add example of keep stopped

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

* update controller class diagram

Signed-off-by: Takamasa Horibe <horibe.takamasa@gmail.com>

Signed-off-by: kosuke55 <kosuke.tnp@gmail.com>
Signed-off-by: Takamasa Horibe <horibe.takamasa@gmail.com>
Co-authored-by: Takamasa Horibe <horibe.takamasa@gmail.com>
yukke42 pushed a commit to tzhong518/autoware.universe that referenced this pull request Oct 14, 2022
…towarefoundation#1591)

* docs(trajectory_follower, trajectory_follower_nodes): update docs

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

* remove auto issue link

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

* correct sentences

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

* add example of keep stopped

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

* update controller class diagram

Signed-off-by: Takamasa Horibe <horibe.takamasa@gmail.com>

Signed-off-by: kosuke55 <kosuke.tnp@gmail.com>
Signed-off-by: Takamasa Horibe <horibe.takamasa@gmail.com>
Co-authored-by: Takamasa Horibe <horibe.takamasa@gmail.com>
boyali referenced this pull request in boyali/autoware.universe Oct 19, 2022
…er4#1591)

* docs(trajectory_follower, trajectory_follower_nodes): update docs

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

* remove auto issue link

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

* correct sentences

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

* add example of keep stopped

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

* update controller class diagram

Signed-off-by: Takamasa Horibe <horibe.takamasa@gmail.com>

Signed-off-by: kosuke55 <kosuke.tnp@gmail.com>
Signed-off-by: Takamasa Horibe <horibe.takamasa@gmail.com>
Co-authored-by: Takamasa Horibe <horibe.takamasa@gmail.com>
saka1-s pushed a commit to saka1-s/autoware.universe that referenced this pull request Nov 1, 2024
…autowarefoundation#8681) (autowarefoundation#1591)

Co-authored-by: TaikiYamada4 <129915538+TaikiYamada4@users.noreply.github.com>
saka1-s added a commit to saka1-s/autoware.universe that referenced this pull request Nov 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type:documentation Creating or refining documentation. (auto-assigned)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants