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

chore(simple_object_merger): update README #6146

Conversation

scepter914
Copy link
Contributor

Description

This PR update for the document of simple_object_merger.
It mainly to add document for tuning parameters and the table style made it hard to read, so this PR changed it to bullet points.

Tests performed

No need

Effects on system behavior

No effect

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.

Signed-off-by: scepter914 <scepter914@gmail.com>
@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) labels Jan 23, 2024
pre-commit-ci bot and others added 4 commits January 23, 2024 04:40
Signed-off-by: scepter914 <scepter914@gmail.com>
Signed-off-by: scepter914 <scepter914@gmail.com>
@scepter914 scepter914 added the tag:run-build-and-test-differential Mark to enable build-and-test-differential workflow. (used-by-ci) label Jan 23, 2024
Copy link

codecov bot commented Jan 23, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (f5cef6c) 14.60% compared to head (59ff7c4) 14.60%.
Report is 10 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #6146   +/-   ##
=======================================
  Coverage   14.60%   14.60%           
=======================================
  Files        1860     1860           
  Lines      127418   127418           
  Branches    37286    37286           
=======================================
  Hits        18609    18609           
  Misses      87902    87902           
  Partials    20907    20907           
Flag Coverage Δ *Carryforward flag
differential 0.00% <ø> (?)
total 14.60% <ø> (ø) Carriedforward from f5cef6c

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

Copy link
Contributor

@miursh miursh left a comment

Choose a reason for hiding this comment

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

I agree with a bullet-point format for explanations.
Even though, we might need to add/keep auto-generated table of parameters from JSON Schema .

@scepter914 scepter914 merged commit 98f2a71 into autowarefoundation:main Jan 25, 2024
32 of 33 checks passed
@scepter914 scepter914 deleted the chore/simple_object_merger_readme branch January 25, 2024 06:12
karishma1911 pushed a commit to Interplai/autoware.universe that referenced this pull request Jun 3, 2024
* chore(simple_object_merger): update README

Signed-off-by: scepter914 <scepter914@gmail.com>

* style(pre-commit): autofix

* update README

Signed-off-by: scepter914 <scepter914@gmail.com>

* style(pre-commit): autofix

* update README

Signed-off-by: scepter914 <scepter914@gmail.com>

---------

Signed-off-by: scepter914 <scepter914@gmail.com>
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) tag:run-build-and-test-differential Mark to enable build-and-test-differential workflow. (used-by-ci) type:documentation Creating or refining documentation. (auto-assigned)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants