Add LaTeX formatting to doc comments #118
Open
+58
−18
Conversation
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
jbangelo
force-pushed
the
jbangelo/latex-formatting
branch
from
d25c76c to
e0d5b31
Compare
There was a problem hiding this comment.
Pull Request Overview
This pull request enhances documentation clarity by introducing LaTeX formatting to doc comments and adding KaTeX support for HTML-rendered docs.
- Updated transformation documentation in swiftnav/src/reference_frame/mod.rs with LaTeX equations
- Reformatted the CRC polynomial in swiftnav/src/edc.rs and coordinate conversion formulas in swiftnav/src/coords.rs
- Configured Cargo.toml and added katex-header.html to support math rendering on docs.rs
Reviewed Changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| swiftnav/src/reference_frame/mod.rs | Updated doc comments for Helmert transformation with LaTeX formatting |
| swiftnav/src/edc.rs | Reformatted CRC polynomial comment using LaTeX delimiters |
| swiftnav/src/coords.rs | Updated coordinate conversion formulas to use LaTeX notation |
| swiftnav/Cargo.toml | Added docs.rs metadata for KaTeX header inclusion |
| katex-header.html | Added KaTeX header with required CSS and JS includes |
Comments suppressed due to low confidence (1)
swiftnav/src/reference_frame/mod.rs:144
- The word 'tranformation' appears to be misspelled; it should be 'transformation'.
/// 3 dimensional rotation, and a universal scaling. The tranformation takes the form of:
pcrumley
approved these changes
Apr 22, 2025
| # This tells docs.rs to include the katex header for math formatting | ||
| # To do this locally | ||
| [package.metadata.docs.rs] | ||
| rustdoc-args = [ "--html-in-header", "katex-header.html" ] |
Comment on lines
+8
to
+11
| {left: "$$", right: "$$", display: true}, | ||
| {left: "\\(", right: "\\)", display: false}, | ||
| {left: "$", right: "$", display: false}, | ||
| {left: "\\[", right: "\\]", display: true} |
There was a problem hiding this comment.
How do overlapping rules work here? Would the
{left: "$", right: "$", display: false}
supersede the
{left: "$$", right: "$$", display: true}
john-michaelburke
approved these changes
Apr 28, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
There are a few places where a bit of LaTeX would help make things a bit more clear in our documentation. Indeed the C library documentation has several uses of LaTeX which Doxygen handles. This is based on the rustdoc-katex-demo crate, which demonstates how to include a link to the KaTex code in the HTML generated for the documents.