-
Notifications
You must be signed in to change notification settings - Fork 28.9k
[SPARK-9980][BUILD] Fix SBT publishLocal error due to invalid characters in doc #8209
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
Conversation
|
test this please |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this isn't more valid as HTML. Was this just an extraneous change?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
So it turns out that javadoc in java 8 doesn't allow self-closing elements (<br/> and <p/>) any more:
http://stackoverflow.com/questions/26049329/javadoc-in-jdk-8-invalid-self-closing-element-not-allowed
http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html#format
<p> is the preferred seperator for a paragraph. So its is not HTML but Javadoc we are talking about. Sorry about the confusion.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hm I though that's because it now required valid HTML, like <p>...</p>. Well, if it fixes an error, obviously that's better than an error. There seem to be ~17 occurrences of this in the code base though -- worth fixing it in one go?
|
I found several instances of a similar javadoc problem in:
Let's clean those up along the way? |
|
I'll change those as well. It is strange that these didn't create problems; I guess it has something to do with the position of the << in the line. |
|
I have replaced |
|
Hm, still seems better for consistency and/or to future-proof; to the extent the docs are read as HTML it isn't valid. I don't feel super strongly about addressing it now though if it's not causing an error. |
|
I'd rather leave the scala source alone for now. |
|
Test build #40896 has finished for PR 8209 at commit
|
|
Test build #1607 has finished for PR 8209 at commit
|
…ters in doc Tiny modification to a few comments ```sbt publishLocal``` work again. Author: Herman van Hovell <[email protected]> Closes #8209 from hvanhovell/SPARK-9980. (cherry picked from commit a85fb6c) Signed-off-by: Sean Owen <[email protected]>
…ters in doc Tiny modification to a few comments ```sbt publishLocal``` work again. Author: Herman van Hovell <[email protected]> Closes apache#8209 from hvanhovell/SPARK-9980.
Tiny modification to a few comments
sbt publishLocalwork again.