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

fix(perception): fix perception docs #9766

Merged
merged 9 commits into from
Dec 25, 2024

Conversation

vividf
Copy link
Contributor

@vividf vividf commented Dec 24, 2024

Description

There are several pages in perception docs that are broken on the website.
This PR fixes the issue including the wrong path and schema error.

Related links

Parent Issue:

  • Link

How was this PR tested?

Notes for reviewers

None.

Interface changes

None.

Effects on system behavior

None.

@vividf vividf self-assigned this Dec 24, 2024
@github-actions github-actions bot added type:documentation Creating or refining documentation. (auto-assigned) component:perception Advanced sensor data processing and environment understanding. (auto-assigned) tag:require-cuda-build-and-test labels Dec 24, 2024
Copy link

github-actions bot commented Dec 24, 2024

Thank you for contributing to the Autoware project!

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

Please ensure:

@vividf vividf added run:deploy-docs Mark for deploy-docs action generation. (used-by-ci) run:build-and-test-differential Mark to enable build-and-test-differential workflow. (used-by-ci) and removed type:documentation Creating or refining documentation. (auto-assigned) component:perception Advanced sensor data processing and environment understanding. (auto-assigned) tag:require-cuda-build-and-test labels Dec 24, 2024
Copy link

codecov bot commented Dec 24, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 29.70%. Comparing base (3d53032) to head (e77c495).
Report is 10 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #9766      +/-   ##
==========================================
+ Coverage   29.66%   29.70%   +0.04%     
==========================================
  Files        1450     1453       +3     
  Lines      108833   108860      +27     
  Branches    42740    42742       +2     
==========================================
+ Hits        32285    32342      +57     
+ Misses      73375    73340      -35     
- Partials     3173     3178       +5     
Flag Coverage Δ *Carryforward flag
differential 10.34% <ø> (?)
differential-cuda 10.34% <ø> (?)
total 29.72% <ø> (+0.05%) ⬆️ Carriedforward from a34bf00

*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.

@github-actions github-actions bot added type:documentation Creating or refining documentation. (auto-assigned) component:perception Advanced sensor data processing and environment understanding. (auto-assigned) tag:require-cuda-build-and-test labels Dec 24, 2024
@xmfcx xmfcx force-pushed the fix/fix_perception_docs branch from d986c2b to 9315445 Compare December 24, 2024 12:10
Copy link
Contributor

@technolojin technolojin left a comment

Choose a reason for hiding this comment

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

I added some missing default values.

@technolojin
Copy link
Contributor

I saw some tables are merged together because the markdown interpreted those as a table

{{ json_to_markdown("perception/autoware_object_merger/schema/object_association_merger.schema.json") }}
{{ json_to_markdown("perception/autoware_object_merger/schema/data_association_matrix.schema.json") }}
{{ json_to_markdown("perception/autoware_object_merger/schema/overlapped_judge.schema.json") }}

We need to set space between the script

{{ json_to_markdown("perception/autoware_object_merger/schema/object_association_merger.schema.json") }}

{{ json_to_markdown("perception/autoware_object_merger/schema/data_association_matrix.schema.json") }}

{{ json_to_markdown("perception/autoware_object_merger/schema/overlapped_judge.schema.json") }}

Can you implement this change in similar places?

or maybe more

@vividf
Copy link
Contributor Author

vividf commented Dec 25, 2024

@technolojin
Thanks for your suggestions!
They are fixed in e77c495

@vividf vividf requested a review from technolojin December 25, 2024 04:59
Copy link
Contributor

@technolojin technolojin left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Contributor

@YoshiRi YoshiRi left a comment

Choose a reason for hiding this comment

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

LGTM

@YoshiRi YoshiRi merged commit 2465d07 into autowarefoundation:main Dec 25, 2024
35 of 36 checks passed
kminoda pushed a commit to kminoda/autoware.universe that referenced this pull request Dec 27, 2024
* fix: fix perception docs

Signed-off-by: vividf <[email protected]>

* fix: fix missing parameter in schema

Signed-off-by: vividf <[email protected]>

* Update perception/autoware_object_merger/schema/data_association_matrix.schema.json

Co-authored-by: Taekjin LEE <[email protected]>

* Update perception/autoware_object_merger/schema/data_association_matrix.schema.json

Co-authored-by: Taekjin LEE <[email protected]>

* Update perception/autoware_object_merger/schema/data_association_matrix.schema.json

Co-authored-by: Taekjin LEE <[email protected]>

* Update perception/autoware_object_merger/schema/data_association_matrix.schema.json

Co-authored-by: Taekjin LEE <[email protected]>

* style(pre-commit): autofix

* chore: seperate paramters for different nodes

Signed-off-by: vividf <[email protected]>

---------

Signed-off-by: vividf <[email protected]>
Co-authored-by: Taekjin LEE <[email protected]>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component:perception Advanced sensor data processing and environment understanding. (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) tag:require-cuda-build-and-test type:documentation Creating or refining documentation. (auto-assigned)
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

3 participants