[SPARK-19389][ML][PYTHON][DOC] Minor doc fixes for ML Python Params and LinearSVC #16723
Conversation
… classes. fixed doc links for LinearSVC
|
@wangmiao1981 Would you mind checking this? It has small fixes I noticed when reviewing your PR for Python LinearSVC. |
|
Test build #72094 has finished for PR 16723 at commit
|
| * :: Experimental :: | ||
| * | ||
| * Linear SVM Classifier (https://en.wikipedia.org/wiki/Support_vector_machine#Linear_SVM) | ||
| * [[https://en.wikipedia.org/wiki/Support_vector_machine#Linear_SVM Linear SVM Classifier]] |
There was a problem hiding this comment.
Would you mind changing it to
* <a href="https://en.wikipedia.org/wiki/Support_vector_machine#Linear_SVM">
* Linear SVM Classifier</a>
? It seems scala link annotation breaks Javadoc8 as below:
[error] .../spark/mllib/target/java/org/apache/spark/ml/classification/LinearSVC.java:5: error: unexpected text
[error] * {@link https://en.wikipedia.org/wiki/Support_vector_machine#Linear_SVM Linear SVM Classifier}
I tested this via ./build/sbt unidoc with Java 8.
(Currently, it seems there are already few errors. Let me fix them with other warnings in near future).
+Just FYI, there are few cases I have found and fixed in #16013
There was a problem hiding this comment.
@jkbradley I checked several other scala files like, GBTRegressor.scala, DecisonTreeRegressor.scala etc. URLs are in the format of <a href>...</a>.
|
@jkbradley Sorry for replying late! I was out for Chinese new year this weekend. I will check the issue mentioned by HyukjinKwon otherwise, it looks good to me. |
|
I delayed too! I just pushed a fix. I couldn't test it since it looks like the Java 8 doc gen has already been broken again. (Thanks a lot for the efforts to fix it! Btw, are you pinging the people who break it whenever you see issues?) |
|
(IMHO, at least for now, building javadoc everytime might be good to do but not required. We can avoid them at our best in our PRs and then sweep them when the release is close or in other related PRs if there are) |
|
Test build #72265 has finished for PR 16723 at commit
|
|
(I just rebased it based on this PR and built the javadoc8 for sure. I believe it should show an error in those newly introduced errors if this PR introduce the break but it seems not. So, LGTM for doc changes.) |
|
OK thanks a lot @HyukjinKwon and @wangmiao1981 ! |
…nd LinearSVC ## What changes were proposed in this pull request? * Removed Since tags in Python Params since they are inherited by other classes * Fixed doc links for LinearSVC ## How was this patch tested? * doc tests * generating docs locally and checking manually Author: Joseph K. Bradley <[email protected]> Closes apache#16723 from jkbradley/pyparam-fix-doc.
4 participants
What changes were proposed in this pull request?
How was this patch tested?