[GitHub] spark issue #14380: [SPARK-16485][DOC][ML] Remove useless latex in scaladoc ...

[lins05]

Github user lins05 commented on the issue:

    https://github.com/apache/spark/pull/14380
  
    @srowen I have looked about those files, but for complex equations, (e.g. 
[this 
one](https://github.com/apache/spark/blob/v2.0.0/mllib/src/main/scala/org/apache/spark/ml/regression/LinearRegression.scala#L778-L782))
 I found it difficult to strip the latex symbols without affecting the 
readability of the javadoc: With the latex symbols there, the users can copy 
the equation and feed it to a latex viewer like [mathjax online 
previewer](https://cdn.mathjax.org/mathjax/latest/test/sample-dynamic.html), 
but it would make it impossible if we remove latex symbols from it.
    
    Meanwhile I find it's possible to use MathJax to render the latex in the 
scaladoc, as long as we add the necessary javascript to load the MathJax in the 
scaladoc javascript template. I played with it a bit and you can see the 
screenshot:
    
    <img width="965" alt="screen shot 2016-07-31 at 12 41 38 am" 
src="https://cloud.githubusercontent.com/assets/717363/17271812/d9c40b00-56b8-11e6-9c17-affac4706153.png";>
    
    Do you think it's a good idea to do it?



---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---

---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscr...@spark.apache.org
For additional commands, e-mail: reviews-h...@spark.apache.org