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

Replace TeX escape sequences with unicode counterparts #487

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

abhro
Copy link
Contributor

@abhro abhro commented Mar 15, 2025

The default KaTeX renderer supports it, and it also clears up the docstrings when viewing in the REPL

The default KaTeX renderer supports it, and it also clears up the docstrings when viewing in the REPL
Copy link

codecov bot commented Mar 15, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 94.11%. Comparing base (f8fd782) to head (1db90d6).

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #487   +/-   ##
=======================================
  Coverage   94.11%   94.11%           
=======================================
  Files          14       14           
  Lines        2905     2905           
=======================================
  Hits         2734     2734           
  Misses        171      171           
Flag Coverage Δ
unittests 94.11% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@stevengj
Copy link
Member

Do MathJaX and other renderers also support it? We also want it to work in things like Jupyter notebooks, vsCode, etcetera.

Looks like it works in Jupyter and vsCode, at least.

@abhro
Copy link
Contributor Author

abhro commented Mar 16, 2025

Do MathJaX and other renderers also support it? We also want it to work in things like Jupyter notebooks, vsCode, etcetera.

I don't think MathJaX supports it out of the box, in my experience, but you can use macros with Documenter to define them.

Correction: I just tested this on Pluto, and it uses MathJaX and works fine. I think that's the benefit coming from Julia's Markdown.jl parser? Either way, I think it works on all platforms we've checked, but I'd be happy to test this on other platforms as needed!

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.

2 participants