diff options
author | hyukjinkwon <gurwls223@gmail.com> | 2017-02-01 13:26:16 +0000 |
---|---|---|
committer | Sean Owen <sowen@cloudera.com> | 2017-02-01 13:26:16 +0000 |
commit | f1a1f2607d44416a5d2f37ca1746cc7e881895b9 (patch) | |
tree | c54cff55168762bb5c6a60659d379d8a853356a4 /docs/js/api-docs.js | |
parent | 9ac05225e870e41dc86cd6d61c7f0d111d172810 (diff) | |
download | spark-f1a1f2607d44416a5d2f37ca1746cc7e881895b9.tar.gz spark-f1a1f2607d44416a5d2f37ca1746cc7e881895b9.tar.bz2 spark-f1a1f2607d44416a5d2f37ca1746cc7e881895b9.zip |
[SPARK-19402][DOCS] Support LaTex inline formula correctly and fix warnings in Scala/Java APIs generation
## What changes were proposed in this pull request?
This PR proposes three things as below:
- Support LaTex inline-formula, `\( ... \)` in Scala API documentation
It seems currently,
```
\( ... \)
```
are rendered as they are, for example,
<img width="345" alt="2017-01-30 10 01 13" src="https://cloud.githubusercontent.com/assets/6477701/22423960/ab37d54a-e737-11e6-9196-4f6229c0189c.png">
It seems mistakenly more backslashes were added.
- Fix warnings Scaladoc/Javadoc generation
This PR fixes t two types of warnings as below:
```
[warn] .../spark/sql/catalyst/src/main/scala/org/apache/spark/sql/Row.scala:335: Could not find any member to link for "UnsupportedOperationException".
[warn] /**
[warn] ^
```
```
[warn] .../spark/sql/core/src/main/scala/org/apache/spark/sql/internal/VariableSubstitution.scala:24: Variable var undefined in comment for class VariableSubstitution in class VariableSubstitution
[warn] * `${var}`, `${system:var}` and `${env:var}`.
[warn] ^
```
- Fix Javadoc8 break
```
[error] .../spark/mllib/target/java/org/apache/spark/ml/PredictionModel.java:7: error: reference not found
[error] * E.g., {link VectorUDT} for vector features.
[error] ^
[error] .../spark/mllib/target/java/org/apache/spark/ml/PredictorParams.java:12: error: reference not found
[error] * E.g., {link VectorUDT} for vector features.
[error] ^
[error] .../spark/mllib/target/java/org/apache/spark/ml/Predictor.java:10: error: reference not found
[error] * E.g., {link VectorUDT} for vector features.
[error] ^
[error] .../spark/sql/hive/target/java/org/apache/spark/sql/hive/HiveAnalysis.java:5: error: reference not found
[error] * Note that, this rule must be run after {link PreprocessTableInsertion}.
[error] ^
```
## How was this patch tested?
Manually via `sbt unidoc` and `jeykil build`.
Author: hyukjinkwon <gurwls223@gmail.com>
Closes #16741 from HyukjinKwon/warn-and-break.
Diffstat (limited to 'docs/js/api-docs.js')
-rw-r--r-- | docs/js/api-docs.js | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/docs/js/api-docs.js b/docs/js/api-docs.js index 96c63cc127..13514e11b9 100644 --- a/docs/js/api-docs.js +++ b/docs/js/api-docs.js @@ -50,7 +50,7 @@ $(document).ready(function() { MathJax.Hub.Config({ displayAlign: "left", tex2jax: { - inlineMath: [ ["$", "$"], ["\\\\(","\\\\)"] ], + inlineMath: [ ["$", "$"], ["\\(","\\)"] ], displayMath: [ ["$$","$$"], ["\\[", "\\]"] ], processEscapes: true, skipTags: ['script', 'noscript', 'style', 'textarea', 'pre', 'a'] |