Skip to content

docs: add annotations regarding the content of the latest diagnostics#237

Open
Motsu-san wants to merge 2 commits into
developfrom
doc/about_new_ekf_localizer_diagnostics
Open

docs: add annotations regarding the content of the latest diagnostics#237
Motsu-san wants to merge 2 commits into
developfrom
doc/about_new_ekf_localizer_diagnostics

Conversation

@Motsu-san
Copy link
Copy Markdown
Contributor

@Motsu-san Motsu-san commented Oct 8, 2025

Types of PR

  • New Features
  • Upgrade of existing features
  • Bugfix

Description

Related link

autowarefoundation/autoware_core#668
autowarefoundation/autoware_core#664

How to review this PR

Others

@Motsu-san Motsu-san marked this pull request as ready for review October 10, 2025 01:08
Copilot AI review requested due to automatic review settings October 10, 2025 01:08
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR updates the localization documentation to clarify that the localization: ekf_localizer diagnostic may be subdivided into multiple specific diagnostic messages in certain cases.

  • Updated Japanese and English documentation with additional annotation explaining diagnostic subdivision
  • Provided specific example of subdivided diagnostic naming pattern

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File Description
docs/use_case/localization.ja.md Added Japanese annotation explaining diagnostic subdivision with example
docs/use_case/localization.en.md Added English annotation explaining diagnostic subdivision with example

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

@Motsu-san Motsu-san added the documentation Improvements or additions to documentation label Oct 10, 2025
Copy link
Copy Markdown
Contributor

@MasatoSaeki MasatoSaeki left a comment

Choose a reason for hiding this comment

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

Thank you for PR!

Could you paste the link about localization diagnostics to track and reference its information? (it feels a bit vague)

Signed-off-by: Motsu-san <83898149+Motsu-san@users.noreply.github.com>
Signed-off-by: Motsu-san <83898149+Motsu-san@users.noreply.github.com>
@Motsu-san Motsu-san force-pushed the doc/about_new_ekf_localizer_diagnostics branch from c12a65d to 4fc04fa Compare October 17, 2025 01:26
@Motsu-san
Copy link
Copy Markdown
Contributor Author

@MasatoSaeki Yes. I added the link of diagnostics contents to the documents just before.
After all related pull-requests are merged, you can see this contents

Copy link
Copy Markdown
Contributor

@MasatoSaeki MasatoSaeki left a comment

Choose a reason for hiding this comment

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

LGTM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants