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(mpc_lateral_controller): modify mathjax visualization error #6486

Conversation

sak-0822
Copy link
Contributor

@sak-0822 sak-0822 commented Feb 24, 2024

Description

Fix 2 mathjax visualization error

Missing or unrecognized delimiter for \left

github-mathjax doesn't recognize
\left{ }\right

orsharir/github-mathjax#16

Screenshot 2024-02-24 at 16 06 41

So I fix it as \lbrace, \rbrace.

image

Some equation aren't output because of "\dot{u}.

Screenshot 2024-02-24 at 16 06 58

So I fix it as \dot u

image

Tests performed

Not applicable.

Effects on system behavior

Not applicable.

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.

@github-actions github-actions bot added type:documentation Creating or refining documentation. (auto-assigned) component:control Vehicle control algorithms and mechanisms. (auto-assigned) labels Feb 24, 2024
@sak-0822 sak-0822 changed the title docs: modify mathjax visualization error docs(mpc_lateral_controller): modify mathjax visualization error Feb 24, 2024
@takayuki5168
Copy link
Contributor

@sak-0822
Thank you so much!

Some of the matrix was converted to the vector by this PR as follows for example. Can you fix them? \ means the new row for the matrix.
image

@takayuki5168 takayuki5168 added the run:build-and-test-differential Mark to enable build-and-test-differential workflow. (used-by-ci) label Feb 26, 2024
@sak-0822
Copy link
Contributor Author

@takayuki5168
Thank you for your reviewing.

Some of the matrix was converted to the vector by this PR as follows for example. Can you fix them? \ means the new row for the matrix.

I changed "\" to "\". By doing so, I was able to confirm that the matrix is displayed correctly.
For example:

\begin{align} \begin{bmatrix} -1 & 1 & 0 \\\ 1 & -1 & 0 \\\ 0 & -1 & 1 \\\ 0 & 1 & -1 \end{bmatrix}\begin{bmatrix} u_{0} \\\ u_{1} \\\ u_{2} \end{bmatrix} \leq \begin{bmatrix} \dot u_{max}\text{d}t \\\ -\dot u_{min}\text{d}t \\\ \dot u_{max}\text{d}t \\\ -\dot u_{min}\text{d}t \end{bmatrix} \end{align}

The output:

image

@sak-0822 sak-0822 force-pushed the docs/model_predictive_control_algorithm.md branch from e14df52 to 387bbdd Compare February 26, 2024 13:44
@takayuki5168 takayuki5168 added the run:deploy-docs Mark for deploy-docs action generation. (used-by-ci) label Feb 27, 2024
Copy link

codecov bot commented Feb 27, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 14.79%. Comparing base (44e4be7) to head (0856bfa).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #6486   +/-   ##
=======================================
  Coverage   14.79%   14.79%           
=======================================
  Files        1917     1917           
  Lines      132001   132001           
  Branches    39228    39228           
=======================================
  Hits        19524    19524           
  Misses      90688    90688           
  Partials    21789    21789           
Flag Coverage Δ *Carryforward flag
differential 45.00% <ø> (?)
total 14.79% <ø> (ø) Carriedforward from 44e4be7

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

@takayuki5168 takayuki5168 force-pushed the docs/model_predictive_control_algorithm.md branch from 387bbdd to 0856bfa Compare March 3, 2024 12:38
@takayuki5168
Copy link
Contributor

@sak-0822
All the CI has passed. Now you can merge the PR anytime.
Thank you for your contribution!

Just FYI, we have a similar document in the following, and the same issue is happening. We are very happy if you have time to fix it.
https://autowarefoundation.github.io/autoware.universe/pr-6486/planning/obstacle_avoidance_planner/docs/mpt/

@takayuki5168 takayuki5168 merged commit b5c29fc into autowarefoundation:main Mar 31, 2024
24 checks passed
karishma1911 pushed a commit to Interplai/autoware.universe that referenced this pull request Jun 3, 2024
…owarefoundation#6486)

* docs: modified mathjacs error

* test

* fix

* docs(mpc_lateral_controller): modify mathjax visualization error

Signed-off-by: root <root@DESKTOP-EP0T4HP>

---------

Signed-off-by: root <root@DESKTOP-EP0T4HP>
Co-authored-by: Daiki Sakanoue <sak@Daikis-MacBook-Air.local>
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