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.

Sign up for GitHub

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

Jump to bottom

docs(out_of_lane): update documentation for the new design #8692

Merged
merged 8 commits into from
Sep 2, 2024
Merged

docs(out_of_lane): update documentation for the new design #8692

merged 8 commits into from
Sep 2, 2024

Conversation

maxime-clem
Copy link
Contributor

@maxime-clem maxime-clem commented Aug 30, 2024 •
edited
Loading

Description

This PR updates the documentation of the out_of_lane module for the new design (#8453).
The debug markers are also improved.

Related links

Parent Issue:

  • Link

How was this PR tested?

Notes for reviewers

None.

Interface changes

None.

Effects on system behavior

None.

@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 Aug 30, 2024
@github-actions GitHub Actions
Copy link

github-actions bot commented Aug 30, 2024 •
edited
Loading

Thank you for contributing to the Autoware project!

🚧 If your pull request is in progress, switch it to draft mode.

Please ensure:

@maxime-clem maxime-clem added the run:deploy-docs Mark for deploy-docs action generation. (used-by-ci) label Aug 30, 2024
@github-actions GitHub Actions
Copy link

Documentation URL: https://autowarefoundation.github.io/autoware.universe/pr-8692/
Modified URLs:

@maxime-clem maxime-clem added the run:build-and-test-differential Mark to enable build-and-test-differential workflow. (used-by-ci) label Aug 30, 2024
@codecov Codecov
Copy link

codecov bot commented Aug 30, 2024 •
edited
Loading

Codecov Report

Attention: Patch coverage is 52.63158% with 9 lines in your changes missing coverage. Please review.

Project coverage is 24.13%. Comparing base (0a364d2) to head (1943a26).
Report is 11 commits behind head on main.

Files with missing lines Patch % Lines
...e_motion_velocity_out_of_lane_module/src/debug.cpp 55.55% 8 Missing ⚠️
...city_out_of_lane_module/src/out_of_lane_module.cpp 0.00% 1 Missing ⚠️
Additional details and impacted files 
@@           Coverage Diff           @@
##             main    #8692   +/-   ##
=======================================
  Coverage   24.12%   24.13%           
=======================================
  Files        1400     1404    +4     
  Lines      102260   102299   +39     
  Branches    38752    38770   +18     
=======================================
+ Hits        24675    24689   +14     
- Misses      75053    75117   +64     
+ Partials     2532     2493   -39
Flag Coverage Δ *Carryforward flag
differential 16.54% <52.63%> (?)
total 24.12% <ø> (-0.01%) ⬇️ Carriedforward from 544b06e

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

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@maxime-clem maxime-clem marked this pull request as ready for review August 30, 2024 12:26
@maxime-clem
WIP update doc
e47d2da 
Signed-off-by: Maxime CLEMENT <maxime.clement@tier4.jp>
@maxime-clem
improve debug markers
2c950b6 
Signed-off-by: Maxime CLEMENT <maxime.clement@tier4.jp>
@maxime-clem
update pictures
7c9e45c 
Signed-off-by: Maxime CLEMENT <maxime.clement@tier4.jp>
@maxime-clem
Complete readme for the new design
50c8976 
Signed-off-by: Maxime CLEMENT <maxime.clement@tier4.jp>
@maxime-clem
remove unused parameter
b3c62f6 
Signed-off-by: Maxime CLEMENT <maxime.clement@tier4.jp>
@maxime-clem
fix spelling
e12d519 
Signed-off-by: Maxime CLEMENT <maxime.clement@tier4.jp>
@maxime-clem
fix minor mistakes
44fbdd0 
Signed-off-by: Maxime CLEMENT <maxime.clement@tier4.jp>
@maxime-clem
reduce number of arguments of the add_polygons_markers function
1943a26 
Signed-off-by: Maxime CLEMENT <maxime.clement@tier4.jp>
@maxime-clem maxime-clem merged commit abcf3ee into autowarefoundation:main Sep 2, 2024
31 checks passed
@maxime-clem maxime-clem deleted the docs/out_of_lane branch September 2, 2024 10:40
batuhanbeytekin pushed a commit to batuhanbeytekin/autoware.universe that referenced this pull request Sep 2, 2024
@maxime-clem @batuhanbeytekin
docs(out_of_lane): update documentation for the new design (autowaref…
78a1b03 
…oundation#8692)

Signed-off-by: Maxime CLEMENT <maxime.clement@tier4.jp>
Signed-off-by: Batuhan Beytekin <batuhanbeytekin@gmail.com>
emuemuJP pushed a commit to arayabrain/autoware.universe.origin that referenced this pull request Sep 2, 2024
@maxime-clem @emuemuJP
docs(out_of_lane): update documentation for the new design (autowaref…
1e18663 
…oundation#8692)

Signed-off-by: Maxime CLEMENT <maxime.clement@tier4.jp>
Signed-off-by: emuemuJP <k.matsumoto.0807@gmail.com>
maxime-clem added a commit to maxime-clem/autoware.universe that referenced this pull request Sep 4, 2024
@maxime-clem
docs(out_of_lane): update documentation for the new design (autowaref…
02ce3a5 
…oundation#8692)

Signed-off-by: Maxime CLEMENT <maxime.clement@tier4.jp>
This was referenced Sep 4, 2024
Merged
Merged
ktro2828 pushed a commit to ktro2828/autoware.universe that referenced this pull request Sep 18, 2024
@maxime-clem @ktro2828
docs(out_of_lane): update documentation for the new design (autowaref…
5096c09 
…oundation#8692)

Signed-off-by: Maxime CLEMENT <maxime.clement@tier4.jp>
TetsuKawa pushed a commit to tier4/autoware.universe that referenced this pull request Jan 23, 2025
@maxime-clem @TetsuKawa
docs(out_of_lane): update documentation for the new design (autowaref…
7ccd56c 
…oundation#8692)

Signed-off-by: Maxime CLEMENT <maxime.clement@tier4.jp>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@soblin soblin soblin approved these changes

@shmpwk shmpwk Awaiting requested review from shmpwk shmpwk is a code owner

@takayuki5168 takayuki5168 Awaiting requested review from takayuki5168 takayuki5168 is a code owner

@tkimura4 tkimura4 Awaiting requested review from tkimura4 tkimura4 is a code owner

Assignees
No one assigned
Labels
component:planning Route planning, decision-making, and navigation. (auto-assigned) run:build-and-test-differential Mark to enable build-and-test-differential workflow. (used-by-ci) run:deploy-docs Mark for deploy-docs action generation. (used-by-ci) type:documentation Creating or refining documentation. (auto-assigned)
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@maxime-clem @soblin