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(control_performance_analysis): utilize mathjax syntax in readme #9552

Merged
merged 10 commits into from
Dec 3, 2024

Conversation

xmfcx
Copy link
Contributor

@xmfcx xmfcx commented Dec 3, 2024

Description

https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/writing-mathematical-expressions#about-writing-mathematical-expressions

image

This will sacrifice from the maintainability a bit but make it better and more professional for rendered output.

Rendered beautifully in the documentation page too:
https://autowarefoundation.github.io/autoware.universe/pr-9552/control/control_performance_analysis/#outputs

image

Related links

Related PR:

How was this PR tested?

Notes for reviewers

None.

Interface changes

None.

Effects on system behavior

None.

@github-actions github-actions bot added type:documentation Creating or refining documentation. (auto-assigned) component:control Vehicle control algorithms and mechanisms. (auto-assigned) labels Dec 3, 2024
Copy link

github-actions bot commented Dec 3, 2024

Thank you for contributing to the Autoware project!

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

Please ensure:

xmfcx and others added 5 commits December 3, 2024 14:18
\
Signed-off-by: M. Fatih Cırıt <[email protected]>
Signed-off-by: M. Fatih Cırıt <[email protected]>
\
Signed-off-by: M. Fatih Cırıt <[email protected]>
Signed-off-by: M. Fatih Cırıt <[email protected]>
Signed-off-by: M. Fatih Cırıt <[email protected]>
pre-commit-ci bot and others added 2 commits December 3, 2024 12:13
@xmfcx xmfcx self-assigned this Dec 3, 2024
@xmfcx xmfcx 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) labels Dec 3, 2024
Copy link

codecov bot commented Dec 3, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 29.50%. Comparing base (e511605) to head (3851485).
Report is 3 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #9552      +/-   ##
==========================================
- Coverage   29.51%   29.50%   -0.01%     
==========================================
  Files        1444     1445       +1     
  Lines      108528   108553      +25     
  Branches    41404    41407       +3     
==========================================
  Hits        32032    32032              
- Misses      73376    73401      +25     
  Partials     3120     3120              
Flag Coverage Δ *Carryforward flag
differential 0.00% <ø> (?)
total 29.51% <ø> (ø) Carriedforward from e511605

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

@xmfcx xmfcx marked this pull request as ready for review December 3, 2024 12:32
@xmfcx
Copy link
Contributor Author

xmfcx commented Dec 3, 2024

Also it is more consistent with the code now with the updated matrix multiplication ordering:

error_vars.error.value_approximation = error_vec.transpose() * lyap_P_ * error_vec; // x'Px

Ready for review ✅

@xmfcx xmfcx mentioned this pull request Dec 3, 2024
@xmfcx xmfcx changed the title docs: utilize mathjax syntax in readme files docs(control_performance_analysis): utilize mathjax syntax in readme Dec 3, 2024
Copy link
Contributor

@shmpwk shmpwk left a comment

Choose a reason for hiding this comment

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

COOL!

@xmfcx xmfcx merged commit 80f59e7 into main Dec 3, 2024
35 of 36 checks passed
@xmfcx xmfcx deleted the docs/mathjax branch December 3, 2024 14:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component:control Vehicle control algorithms and mechanisms. (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.

2 participants