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(yabloc): replace parameters by json_to_markdown in readme #6183

Merged

Conversation

KYabuuchi
Copy link
Contributor

@KYabuuchi KYabuuchi commented Jan 26, 2024

Description

Fixed parameter visualizations that were not updated in #6170

Tests performed

With the following, I confirmed that there are 10 json.schema under localization/yabloc/.

$ find localization/yabloc/ |grep schema.json
localization/yabloc/yabloc_monitor/schema/yabloc_monitor.schema.json
localization/yabloc/yabloc_image_processing/schema/undistort.schema.json
localization/yabloc/yabloc_image_processing/schema/graph_segment.schema.json
localization/yabloc/yabloc_image_processing/schema/segment_filter.schema.json
localization/yabloc/yabloc_common/schema/ground_server.schema.json
localization/yabloc/yabloc_common/schema/ll2_decomposer.schema.json
localization/yabloc/yabloc_particle_filter/schema/gnss_particle_corrector.schema.json
localization/yabloc/yabloc_particle_filter/schema/camera_particle_corrector.schema.json
localization/yabloc/yabloc_particle_filter/schema/predictor.schema.json
localization/yabloc/yabloc_pose_initializer/schema/camera_pose_initializer.schema.json

Then, I confirmed that json_to_markdown appears 10 times with corresponding schema.json pathes.

$ grep "json_to_markdown" -r localization/yabloc/

localization/yabloc/yabloc_monitor/README.md:{{ json_to_markdown("localization/yabloc/yabloc_monitor/schema/yabloc_monitor.schema.json") }}
localization/yabloc/yabloc_image_processing/README.md:{{ json_to_markdown("localization/yabloc/yabloc_image_processing/schema/graph_segment.schema.json") }}
localization/yabloc/yabloc_image_processing/README.md:{{ json_to_markdown("localization/yabloc/yabloc_image_processing/schema/segment_filter.schema.json") }}
localization/yabloc/yabloc_image_processing/README.md:{{ json_to_markdown("localization/yabloc/yabloc_image_processing/schema/undistort.schema.json") }}
localization/yabloc/yabloc_common/README.md:{{ json_to_markdown("localization/yabloc/yabloc_common/schema/ground_server.schema.json") }}
localization/yabloc/yabloc_common/README.md:{{ json_to_markdown("localization/yabloc/yabloc_common/schema/ll2_decomposer.schema.json") }}
localization/yabloc/yabloc_particle_filter/README.md:{{ json_to_markdown("localization/yabloc/yabloc_particle_filter/schema/predictor.schema.json") }}
localization/yabloc/yabloc_particle_filter/README.md:{{ json_to_markdown("localization/yabloc/yabloc_particle_filter/schema/gnss_particle_corrector.schema.json") }}
localization/yabloc/yabloc_particle_filter/README.md:{{ json_to_markdown("localization/yabloc/yabloc_particle_filter/schema/camera_particle_corrector.schema.json") }}
localization/yabloc/yabloc_pose_initializer/README.md:{{ json_to_markdown("localization/yabloc/yabloc_pose_initializer/schema/camera_pose_initializer.schema.json") }}

Finally, I confirmed with mkdocs

cd autoware/src/universe/autoware.universe/
mkdocs serve
# check documentation in brouser.

Effects on system behavior

Does not affect.

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: Kento Yabuuchi <kento.yabuuchi.2@tier4.jp>
@github-actions github-actions bot added type:documentation Creating or refining documentation. (auto-assigned) component:localization Vehicle's position determination in its environment. (auto-assigned) labels Jan 26, 2024
Signed-off-by: Kento Yabuuchi <kento.yabuuchi.2@tier4.jp>
Signed-off-by: Kento Yabuuchi <kento.yabuuchi.2@tier4.jp>
@KYabuuchi KYabuuchi marked this pull request as ready for review January 26, 2024 05:21
@KYabuuchi KYabuuchi added the run:build-and-test-differential Mark to enable build-and-test-differential workflow. (used-by-ci) label Jan 26, 2024
@KYabuuchi KYabuuchi enabled auto-merge (squash) January 26, 2024 05:22
Copy link

codecov bot commented Jan 26, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (ccd852b) 14.58% compared to head (d62277a) 14.58%.
Report is 5 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #6183   +/-   ##
=======================================
  Coverage   14.58%   14.58%           
=======================================
  Files        1871     1871           
  Lines      127545   127545           
  Branches    37311    37311           
=======================================
  Hits        18606    18606           
  Misses      88019    88019           
  Partials    20920    20920           
Flag Coverage Δ *Carryforward flag
differential 4.48% <ø> (?)
total 14.58% <ø> (ø) Carriedforward from ccd852b

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

@KYabuuchi KYabuuchi merged commit 16ba2d7 into autowarefoundation:main Jan 26, 2024
38 of 39 checks passed
anhnv3991 pushed a commit to anhnv3991/autoware.universe that referenced this pull request Jan 29, 2024
…warefoundation#6183)

* replace parameters by json_to_markdown

Signed-off-by: Kento Yabuuchi <kento.yabuuchi.2@tier4.jp>

* fix some schma path

Signed-off-by: Kento Yabuuchi <kento.yabuuchi.2@tier4.jp>

* fix again

Signed-off-by: Kento Yabuuchi <kento.yabuuchi.2@tier4.jp>

---------

Signed-off-by: Kento Yabuuchi <kento.yabuuchi.2@tier4.jp>
Signed-off-by: anhnv3991 <anh.nguyen.2@tier4.jp>
kyoichi-sugahara pushed a commit to kyoichi-sugahara/autoware.universe that referenced this pull request Jan 29, 2024
…warefoundation#6183)

* replace parameters by json_to_markdown

Signed-off-by: Kento Yabuuchi <kento.yabuuchi.2@tier4.jp>

* fix some schma path

Signed-off-by: Kento Yabuuchi <kento.yabuuchi.2@tier4.jp>

* fix again

Signed-off-by: Kento Yabuuchi <kento.yabuuchi.2@tier4.jp>

---------

Signed-off-by: Kento Yabuuchi <kento.yabuuchi.2@tier4.jp>
karishma1911 pushed a commit to Interplai/autoware.universe that referenced this pull request Jun 3, 2024
…warefoundation#6183)

* replace parameters by json_to_markdown

Signed-off-by: Kento Yabuuchi <kento.yabuuchi.2@tier4.jp>

* fix some schma path

Signed-off-by: Kento Yabuuchi <kento.yabuuchi.2@tier4.jp>

* fix again

Signed-off-by: Kento Yabuuchi <kento.yabuuchi.2@tier4.jp>

---------

Signed-off-by: Kento Yabuuchi <kento.yabuuchi.2@tier4.jp>
@KYabuuchi KYabuuchi deleted the chore/re_rework_parameters branch June 13, 2024 09:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component:localization Vehicle's position determination in its environment. (auto-assigned) 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