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

Latex in docstrings #534

Open
fzimmermann89 opened this issue Nov 14, 2024 · 0 comments
Open

Latex in docstrings #534

fzimmermann89 opened this issue Nov 14, 2024 · 0 comments

Comments

@fzimmermann89
Copy link
Member

We currently use a mix of latex and non-latex in docstrings for equations.

This is a balance between readability in source code,\mathbb{R} \rightarrow \mathbb{R} is quite difficult to read compared to R-> R

@koflera's argument is, that either way you would not look at equations in vscode's popup messages or in code, but that it is more important that the equations look ok in the documentation.

Maybe we should check for the equations we currently have again how they look in docu.

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

No branches or pull requests

1 participant