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] Differentiate Doxygen from LaTeX commands #1558

Merged
merged 2 commits into from
Aug 1, 2023

Conversation

ischoegl
Copy link
Member

@ischoegl ischoegl commented Jul 28, 2023

Changes proposed in this pull request

This PR complements #1557, and solely replaces \f[ / \f] / \f$ by @f[ / @f] / @f$. The change clearly differentiates Doxygen commands from $\LaTeX$ commands. In addition, spaces are added to better separate Doxygen from $\LaTeX$ / improve readability.

While 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

  • The pull request includes a clear description of this code change
  • Commit messages have short titles and reference relevant issues
  • Build passes (scons build & scons test) and unit tests address code coverage
  • Style & formatting of contributed code follows contributing guidelines
  • The pull request is ready for review

speth
speth previously approved these changes Aug 1, 2023
@speth
Copy link
Member

speth commented Aug 1, 2023

Sadly, separating this from #1557 created some merge conflicts. Can you fix these, @ischoegl, so we can merge this?

@ischoegl
Copy link
Member Author

ischoegl commented Aug 1, 2023

Rebased. Could you reapprove?

@speth speth merged commit e2e5e1b into Cantera:main Aug 1, 2023
40 of 41 checks passed
@ischoegl ischoegl deleted the doxygen-final branch August 2, 2023 00:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
No open projects
Development

Successfully merging this pull request may close these issues.

None yet

2 participants