[docs] Differentiate Doxygen from LaTeX commands#1558
Merged
speth merged 2 commits intoCantera:mainfrom Aug 1, 2023
Merged
Conversation
This was referenced Jul 28, 2023
Merged
speth
previously approved these changes
Aug 1, 2023
Member
Member
Author
|
Rebased. Could you reapprove? |
speth
approved these changes
Aug 1, 2023
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Changes proposed in this pull request
This PR complements #1557, and solely replaces$\LaTeX$ commands. In addition, spaces are added to better separate Doxygen from $\LaTeX$ / improve readability.
\f[/\f]/\f$by@f[/@f]/@f$. The change clearly differentiates Doxygen commands fromWhile the PR creates considerable churn, there will not be a question about what style to follow for Doxygen documentation in the future.
If applicable, fill in the issue number this pull request is fixing
Addresses Cantera/enhancements#179
If applicable, provide an example illustrating new features this pull request is introducing
Checklist
scons build&scons test) and unit tests address code coverage