Skip to content

Escape text in math; Fix ref formatting - #762

Open
pkienzle wants to merge 1 commit into
masterfrom
fix-model-docs
Open

pkienzle wants to merge 1 commit into
masterfrom
fix-model-docs

Conversation

@pkienzle

@pkienzle pkienzle commented Sep 25, 2026 •

Copy link
Copy Markdown
Contributor

Some model docs were not putting text strings equations within \text or \mathrm wrappers.

There was an occasional misplaced & symbol in equations.

The references were not always bullet numbered.

An obscure error: #. L. Onsager ... was rendering as 1. 12. Onsager ... because the L. was being treated as an enumeration A. B. C. ... by the reStructuredText parser. The solution was to change it to #. L Onsager ... or #. \L. Onsager ..., depending on the style of the other references in the model.

The final "where ..." block in spherical_sld is complaining about embedded equations on some latex renderers. The equation works when I use it as input for the online KaTeX and MathJax demos so it will probably work here, but we need to check that page in built docs before merging.

Note that this contains an alternate fix to #754, removing the unicode symbols from the C source. That wasn't intended for this PR, but it won't hurt either so I'll leave it.

@codescene-access codescene-access Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

No quality gates enabled for this code.

See analysis details in CodeScene

Quality Gate Profile: Custom Configuration
Install CodeScene MCP: safeguard and uplift AI-generated code. Catch issues early with our IDE extension and CLI tool.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant