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

LaTeX _ escape improvement #2292

Merged
merged 3 commits into from
Apr 2, 2024
Merged

Conversation

joshua-cogliati-inl
Copy link
Contributor

@joshua-cogliati-inl joshua-cogliati-inl commented Mar 29, 2024


Pull Request Description

What issue does this change request address?

Closes #2291

What are the significant changes in functionality due to this change request?

Fixes various latex errors, updates generated documents, and does not escape _ in generateLatex if it is followed by a '{'


For Change Control Board: Change Request Review

The following review must be completed by an authorized member of the Change Control Board.

  • 1. Review all computer code.
  • 2. If any changes occur to the input syntax, there must be an accompanying change to the user manual and xsd schema. If the input syntax change deprecates existing input files, a conversion script needs to be added (see Conversion Scripts).
  • 3. Make sure the Python code and commenting standards are respected (camelBack, etc.) - See on the wiki for details.
  • 4. Automated Tests should pass, including run_tests, pylint, manual building and xsd tests. If there are changes to Simulation.py or JobHandler.py the qsub tests must pass.
  • 5. If significant functionality is added, there must be tests added to check this. Tests should cover all possible options. Multiple short tests are preferred over one large test. If new development on the internal JobHandler parallel system is performed, a cluster test must be added setting, in XML block, the node <internalParallel> to True.
  • 6. If the change modifies or adds a requirement or a requirement based test case, the Change Control Board's Chair or designee also needs to approve the change. The requirements and the requirements test shall be in sync.
  • 7. The merge request must reference an issue. If the issue is closed, the issue close checklist shall be done.
  • 8. If an analytic test is changed/added is the the analytic documentation updated/added?
  • 9. If any test used as a basis for documentation examples (currently found in raven/tests/framework/user_guide and raven/docs/workshop) have been changed, the associated documentation must be reviewed and assured the text matches the example.

\tau and \epsilon only allowed in math mode
Adding missing close $ and \end{itemize}
They are likely in a math context and trying to do a subscript.
@joshua-cogliati-inl joshua-cogliati-inl changed the title Latex escape LaTeX escape Mar 29, 2024
@joshua-cogliati-inl joshua-cogliati-inl changed the title LaTeX escape LaTeX _ escape Mar 29, 2024
@joshua-cogliati-inl joshua-cogliati-inl changed the title LaTeX _ escape LaTeX _ escape improvement Mar 29, 2024
@moosebuild
Copy link

Job Test qsubs sawtooth on b8cd5aa : invalidated by @joshua-cogliati-inl

failed Diff tests/cluster_tests/RavenRunsRaven/CodeRay

Copy link
Collaborator

@wangcj05 wangcj05 left a comment

Choose a reason for hiding this comment

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

Changes look good. Thanks @joshua-cogliati-inl

@wangcj05
Copy link
Collaborator

wangcj05 commented Apr 2, 2024

PR checklist is good.

@wangcj05 wangcj05 merged commit ed708c7 into idaholab:devel Apr 2, 2024
12 checks passed
@joshua-cogliati-inl joshua-cogliati-inl deleted the latex_escape branch April 2, 2024 14:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[TASK] add way to do subscripts in latex generated documentation
3 participants