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 $$ ... $$ with \[ ... \] #125

Closed
hochleitner opened this issue May 11, 2021 · 3 comments
Closed

Replace $$ ... $$ with \[ ... \] #125

hochleitner opened this issue May 11, 2021 · 3 comments
Assignees
Labels
needs investigation Issue or PR dealing with (yet) unclear behavior. question Issue or PR dealing with questions of any kind.

Comments

@hochleitner
Copy link
Member

The use of equations with $$ ... $$ seems to be discouraged in LaTeX since it's a plain TeX command. It can obviously break stuff as mentioned in the following sources:

Reading this I'd say we replace the part in mathematik.tex of the tutorial with the LaTeX friendly syntax, although I'm too little of a LaTeX math expert to say if there are any implications. I did a quick test and didn't see any changes. @imagingbook, could you confirm this?

Also, \( ... \) should then probably used instead of $ ... $ although there is definitely the case of readability that favors the dollar signs.

There are some pros and cons mentioned here: https://tex.stackexchange.com/questions/510/are-and-preferable-to-dollar-signs-for-math-mode. I'm not sure though if most of the things are relevant to our documents.

@hochleitner hochleitner added question Issue or PR dealing with questions of any kind. needs investigation Issue or PR dealing with (yet) unclear behavior. labels May 11, 2021
@imagingbook
Copy link
Collaborator

Reading this (which I did before) I'd say that they never really come forward with a good reason for replacing $ ... $ by \( ... \). Anyone is free to declare "deadly sins", but this one is unreasonable from my point. I strongly suggest to keep the old $...$ scheme simply because it is easier to type and read. Also, some editors do not seem to syntax-highlight properly with \( ... \).
For displayed math I have no objections to change, since we use the AMS package anyways.

@hochleitner
Copy link
Member Author

I agree, so let's replace the double dollar signs and leave the single ones the way they are (this is explicitly not in the deadly sins, only the $$, so I guess they are okay.

If you have a look at the last Stack Exchange link there are quite some discussions who LaTeX 3 will handle all of this. They're already 5 years old, not sure how that turned out or if it's still in discussion. But this is probably the best argument for one syntax or the other because it's probably the most future-proof way to go.

hochleitner added a commit that referenced this issue Jun 24, 2021
@hochleitner
Copy link
Member Author

Closed with commit a971702.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
needs investigation Issue or PR dealing with (yet) unclear behavior. question Issue or PR dealing with questions of any kind.
Projects
None yet
Development

No branches or pull requests

2 participants