[MINOR][BUILD] Fix javadoc8 break #17389
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
HyukjinKwon
commented
Mar 22, 2017
| @@ -224,7 +225,7 @@ trait KeyedState[S] extends LogicalKeyedState[S] { | |||
| /** | |||
| * Set the timeout duration for this key as a string. For example, "1 hour", "2 days", etc. | |||
| * | |||
| * @note, ProcessingTimeTimeout must be enabled in `[map/flatmap]GroupsWithStates`. | |||
There was a problem hiding this comment.
It seems @note, produces a warning as below:
[warn] .../spark/sql/core/src/main/scala/org/apache/spark/sql/streaming/KeyedState.scala:239: Tag '@note,' is not recognised
HyukjinKwon
commented
Mar 22, 2017
| @@ -27,7 +27,7 @@ | |||
| /** | |||
| * ::Experimental:: | |||
| * Base interface for a map function used in | |||
| * {@link org.apache.spark.sql.KeyValueGroupedDataset#flatMapGroupsWithState( | |||
| * {@code org.apache.spark.sql.KeyValueGroupedDataset.flatMapGroupsWithState( | |||
|
I would like to to note my observations. When we introduce a javadoc break, it seems sbt produces other warnings as errors when generating javadoc. For example, with the java code , /**
* Hi
*/
public class A extends B {
}if we run it produces a warning because it does not find B symbol. It seems still generating the documenation fine. However, if we have a javadoc break in comments as below: /**
* Hi
* @see B
*/
public class A extends B {
}this produces an error and warning. and it seems somehow It seems okay to just fix |
|
cc @srowen, could you take a look and see if it makes sense? |
srowen
approved these changes
Mar 22, 2017
|
Just to extend a bit more with the actual example, before this PR after this PR |
|
Thank you for your approval @srowen. |
|
Test build #75053 has finished for PR 17389 at commit
|
|
Test build #3606 has finished for PR 17389 at commit
|
HyukjinKwon
force-pushed
the
minor-javadoc8-fix
branch
from
a00dd50
to
88ee198
Compare
|
Test build #75067 has finished for PR 17389 at commit
|
|
retest this please |
|
Test build #75076 has finished for PR 17389 at commit
|
|
Merged to master |
asfgit
pushed a commit
that referenced
this pull request
Apr 12, 2017
## What changes were proposed in this pull request? This PR proposes to run Spark unidoc to test Javadoc 8 build as Javadoc 8 is easily re-breakable. There are several problems with it: - It introduces little extra bit of time to run the tests. In my case, it took 1.5 mins more (`Elapsed :[94.8746569157]`). How it was tested is described in "How was this patch tested?". - > One problem that I noticed was that Unidoc appeared to be processing test sources: if we can find a way to exclude those from being processed in the first place then that might significantly speed things up. (see joshrosen's [comment](https://issues.apache.org/jira/browse/SPARK-18692?focusedCommentId=15947627&page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#comment-15947627)) To complete this automated build, It also suggests to fix existing Javadoc breaks / ones introduced by test codes as described above. There fixes are similar instances that previously fixed. Please refer #15999 and #16013 Note that this only fixes **errors** not **warnings**. Please see my observation #17389 (comment) for spurious errors by warnings. ## How was this patch tested? Manually via `jekyll build` for building tests. Also, tested via running `./dev/run-tests`. This was tested via manually adding `time.time()` as below: ```diff profiles_and_goals = build_profiles + sbt_goals print("[info] Building Spark unidoc (w/Hive 1.2.1) using SBT with these arguments: ", " ".join(profiles_and_goals)) + import time + st = time.time() exec_sbt(profiles_and_goals) + print("Elapsed :[%s]" % str(time.time() - st)) ``` produces ``` ... ======================================================================== Building Unidoc API Documentation ======================================================================== ... [info] Main Java API documentation successful. ... Elapsed :[94.8746569157] ... Author: hyukjinkwon <[email protected]> Closes #17477 from HyukjinKwon/SPARK-18692.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What changes were proposed in this pull request?
Several javadoc8 breaks have been introduced. This PR proposes fix those instances so that we can build Scala/Java API docs.
How was this patch tested?
Manually via
jekyll build