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

Dollar signs in documentation #13905

Open
novoselt opened this issue Jan 4, 2013 · 1 comment
Open

Dollar signs in documentation #13905

novoselt opened this issue Jan 4, 2013 · 1 comment

Comments

@novoselt
Copy link
Member

novoselt commented Jan 4, 2013

It is allowed to use dollar signs in the documentation to denote math stuff. It is also supposed to be possible to escape them like \$ to get plain dollars. When I put, say, "There are $10 and $5 bills." in a module docstring and build documentation, the text between dollars is in math mode. The same seems to happen with introspection. The source code does show $'s without anything, but it seems that they get caught by MathJax during rendering.

This should not happen: either MathJax should leave $'s alone, or they have to be escaped somehow again (automatically, so that \$ works in the source file).

Sage version: 5.6.beta1.

CC: @jhpalmieri

Component: documentation

Issue created by migration from https://trac.sagemath.org/ticket/13905

@novoselt
Copy link
Member Author

novoselt commented Jan 4, 2013

comment:1

Hi John,

Could you take a look at it? I think I finally understood what's going on after a few hours, but I don't know how to proceed about fixing it.

Thank you!
Andrey

@jdemeyer jdemeyer modified the milestones: sage-5.11, sage-5.12 Aug 13, 2013
@sagetrac-vbraun-spam sagetrac-vbraun-spam mannequin modified the milestones: sage-6.1, sage-6.2 Jan 30, 2014
@sagetrac-vbraun-spam sagetrac-vbraun-spam mannequin modified the milestones: sage-6.2, sage-6.3 May 6, 2014
@sagetrac-vbraun-spam sagetrac-vbraun-spam mannequin modified the milestones: sage-6.3, sage-6.4 Aug 10, 2014
@mkoeppe mkoeppe removed this from the sage-6.4 milestone Dec 29, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants