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

Add missing backslashes in LaTeX syntax in the document of binomial function #29933

Merged
merged 2 commits into from
Nov 7, 2018

Conversation

machakann
Copy link
Contributor

I looked up the document of binomial function in Base today, and it seems a little weird. I think it is because of the lack of backslashes for LaTeX syntax. Could you check?

Copy link
Member

@fredrikekre fredrikekre left a comment

Choose a reason for hiding this comment

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

Thanks! And welcome as a contributor.

@fredrikekre fredrikekre added docs This change adds or pertains to documentation backport pending 1.0 labels Nov 5, 2018
@fredrikekre fredrikekre changed the title Backslashes are somehow lacked for LaTeX syntax in the document of binomial function Add missing backslashes in LaTeX syntax in the document of binomial function Nov 5, 2018
@machakann
Copy link
Contributor Author

Thanks, I'm so happy!

Excuse me, I would like to ask another thing. I'm a little confused now, but probably https://github.com/JuliaLang/julia/blob/master/doc/src/manual/documentation.md#latex might be misleading. Should it also be doubled backslashes? Or, did I miss something?

Surround text that should be displayed as mathematics using ``\\LaTeX`` syntax with double backticks,

@fredrikekre
Copy link
Member

I'm a little confused now, but probably https://github.com/JuliaLang/julia/blob/master/doc/src/manual/documentation.md#latex might be misleading.

The reason it was needed here is that the text are embedded in a julia source file, and you then need to escape \ correctly. This is not needed in the markdown documentation pages, since those are never parsed as julia code. It is a bit unclear in the linked docs what they refer to, and it would be good to add a note about this there. Wanna take a stab at it?

@machakann
Copy link
Contributor Author

Ah, everything gets clear now, thanks! Let me try to add a note.

@machakann
Copy link
Contributor Author

OK, done. Please check.

@fredrikekre fredrikekre merged commit d8df7df into JuliaLang:master Nov 7, 2018
KristofferC pushed a commit that referenced this pull request Nov 12, 2018
@KristofferC KristofferC mentioned this pull request Nov 12, 2018
61 tasks
tkf pushed a commit to tkf/julia that referenced this pull request Nov 21, 2018
KristofferC pushed a commit that referenced this pull request Dec 12, 2018
KristofferC pushed a commit that referenced this pull request Feb 11, 2019
KristofferC pushed a commit that referenced this pull request Feb 20, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs This change adds or pertains to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants