[SPARK-17095] [Documentation] [Latex and Scala doc do not play nicely]

[jagadeesanas2]

What changes were proposed in this pull request?

In Latex, it is common to find "}}}" when closing several expressions at once. SPARK-16822 added Mathjax to render Latex equations in scaladoc. However, when scala doc sees "}}}" or "{{{" it treats it as a special character for code block. This results in some very strange output.

[SparkQA]

Test build #63920 has finished for PR 14688 at commit d50990c.

• This patch fails Scala style tests.
• This patch merges cleanly.
• This patch adds no public classes.

[srowen]

The original problem in the JIRA was LaTeX using }}} and that failing. This is a related but opposite problem, were LaTeX is rendered as simple code. @sethah what instance(s) did you see? But I also think it's worth fixing problems like this too. I can see a few more just by searching for common LaTeX strings like \sum. Feel free to fix anything else of this form.

[SparkQA]

Test build #63922 has finished for PR 14688 at commit 5cb09f7.

• This patch fails Scala style tests.
• This patch merges cleanly.
• This patch adds no public classes.

[SparkQA]

Test build #63924 has finished for PR 14688 at commit 7c8fc6f.

• This patch passes all tests.
• This patch merges cleanly.
• This patch adds no public classes.

[sethah]

Ya, this is not the problem I had. Here is an example:

\frac{e^{\vec{x}_i^T \vec{\beta}_{K-1}}}

The above will cause the scala doc to barf some weird output at the end because of the terminating }}}. The fix I made temporarily would be:

\frac{e^{\vec{x}_i^T \vec{\beta}_{K-1}}\,}

I do not have other instances of this happening in Spark code (that's not to say it doesn't), but it happened on a PR I am currently working on.

[srowen]

@jagadeesanas2 can you follow up on this to address other instances, including the one you opened the other PR for?

[jagadeesanas2]

@srowen I do not find any other instances. Perhaps I send some fixes for Latex string.

[srowen]

OK I was going to say we would also have to fix the instance @sethah notes above, but looks like that was already fixed or was fixed before committing it. OK this looks fine; I'll verify the rendering.

[srowen]

Jenkins retest this please

[SparkQA]

Test build #64194 has finished for PR 14688 at commit d358569.

• This patch passes all tests.
• This patch merges cleanly.
• This patch adds no public classes.

[SparkQA]

Test build #64192 has finished for PR 14688 at commit d358569.

• This patch passes all tests.
• This patch merges cleanly.
• This patch adds no public classes.

[srowen]

Merged to master