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 documentation #7149

Merged
merged 2 commits into from
Jun 11, 2024

Conversation

satoshi-ota
Copy link
Contributor

@satoshi-ota satoshi-ota commented May 28, 2024

Description

Update avoidance module documentation.

Tests performed

Pass CI.

Effects on system behavior

Nothing.

Interface changes

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 May 28, 2024
@satoshi-ota satoshi-ota force-pushed the docs/avoidance branch 2 times, most recently from 3ea46c4 to d7459be Compare May 29, 2024 01:48
@satoshi-ota satoshi-ota added 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) and removed run:build-and-test-differential Mark to enable build-and-test-differential workflow. (used-by-ci) labels May 29, 2024
@satoshi-ota satoshi-ota force-pushed the docs/avoidance branch 3 times, most recently from 16942c0 to d7d74a7 Compare May 30, 2024 01:21
@satoshi-ota satoshi-ota marked this pull request as ready for review May 30, 2024 01:24
@satoshi-ota satoshi-ota force-pushed the docs/avoidance branch 6 times, most recently from d1835a2 to 082159e Compare June 10, 2024 08:51
@go-sakayori
Copy link
Contributor

Maybe the flowchart is not changed, but "Filtering flow for vehicle type objects" -> "Is stopping time longer than threshold" block has 2 no and 0 yes. Furthermore, there is a spelling miss in longher (it should be longer)

@satoshi-ota
Copy link
Contributor Author

@go-sakayori Thank you for your pointing, and I fixed it. Please check it again 🙏

Copy link
Contributor

@go-sakayori go-sakayori left a comment

Choose a reason for hiding this comment

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

Sorry there were some comments pending .....

Copy link
Contributor

Choose a reason for hiding this comment

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

In subsection "Judge if it's a parked vehicle", there is l_a in the equation and L_a in the description. Are they the same?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks! I fixed in cd5955e.

Copy link
Contributor

Choose a reason for hiding this comment

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

I think there is an extra bracket ) after the phrase "path shifter" in section Inner-workings / Algorithms

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Copy link
Contributor

Choose a reason for hiding this comment

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

In section "when target object has gone", there is a typo. targe -> target

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Copy link
Contributor

Choose a reason for hiding this comment

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

In section "yield maneuver" , is sift meant to be shift?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@satoshi-ota
Copy link
Contributor Author

Sorry there were some comments pending .....

Fixed suggested point in cd5955e.

@go-sakayori go-sakayori added the run:build-and-test-differential Mark to enable build-and-test-differential workflow. (used-by-ci) label Jun 11, 2024
Signed-off-by: satoshi-ota <satoshi.ota928@gmail.com>
Signed-off-by: satoshi-ota <satoshi.ota928@gmail.com>
@satoshi-ota satoshi-ota merged commit ec7a2a1 into autowarefoundation:main Jun 11, 2024
23 of 24 checks passed
@satoshi-ota satoshi-ota deleted the docs/avoidance branch June 11, 2024 06:59
KhalilSelyan pushed a commit that referenced this pull request Jul 22, 2024
* docs(avoidance): update documentation

Signed-off-by: satoshi-ota <satoshi.ota928@gmail.com>

* fix: small change

Signed-off-by: satoshi-ota <satoshi.ota928@gmail.com>

---------

Signed-off-by: satoshi-ota <satoshi.ota928@gmail.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: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
Development

Successfully merging this pull request may close these issues.

4 participants