Skip to content

Conversation

@srowen
Copy link
Member

@srowen srowen commented Nov 17, 2018

What changes were proposed in this pull request?

This restores scaladoc artifact generation, which got dropped with the Scala 2.12 update. The change looks large, but is almost all due to needing to make the InterfaceStability annotations top-level classes (i.e. @InterfaceStability.Stable -> @Stable), unfortunately. A few inner class references had to be qualified too.

Lots of scaladoc warnings now reappear. We can choose to disable generation by default and enable for releases, later.

How was this patch tested?

N/A; build runs scaladoc now.

…nd qualify a few inner classes to make scaladoc work.
@SparkQA
Copy link

SparkQA commented Nov 17, 2018

Test build #98964 has finished for PR 23069 at commit 25a311b.

  • This patch fails build dependency tests.
  • This patch merges cleanly.
  • This patch adds no public classes.

@SparkQA
Copy link

SparkQA commented Nov 17, 2018

Test build #4430 has finished for PR 23069 at commit 25a311b.

  • This patch fails Spark unit tests.
  • This patch merges cleanly.
  • This patch adds no public classes.

@SparkQA
Copy link

SparkQA commented Nov 18, 2018

Test build #4432 has finished for PR 23069 at commit 25a311b.

  • This patch passes all tests.
  • This patch merges cleanly.
  • This patch adds no public classes.

Copy link
Member

@felixcheung felixcheung left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LG, how do we check for these kind of things in the future?

@srowen
Copy link
Member Author

srowen commented Nov 18, 2018

How do we check if doc artifacts were built? well, honestly we (meaning, I) should have noticed this in our releases. Docs were obviously generated for the public site, just not the artifacts that get downloaded into IDEs.

Now, the artifacts are always built with the build, so we'll notice if it breaks. We'll also get a lot of build warnings (again), which we may not like, and decide to put this behind the release profile. And then deal with (rare?) breakage at release time.

@srowen
Copy link
Member Author

srowen commented Nov 19, 2018

Merged to master

@srowen srowen closed this Nov 19, 2018
@srowen srowen deleted the SPARK-26026 branch November 19, 2018 15:17
asfgit pushed a commit that referenced this pull request Nov 20, 2018
## What changes were proposed in this pull request?

This restores scaladoc artifact generation, which got dropped with the Scala 2.12 update. The change looks large, but is almost all due to needing to make the InterfaceStability annotations top-level classes (i.e. `InterfaceStability.Stable` -> `Stable`), unfortunately. A few inner class references had to be qualified too.

Lots of scaladoc warnings now reappear. We can choose to disable generation by default and enable for releases, later.

## How was this patch tested?

N/A; build runs scaladoc now.

Closes #23069 from srowen/SPARK-26026.

Authored-by: Sean Owen <[email protected]>
Signed-off-by: Sean Owen <[email protected]>
@cloud-fan
Copy link
Contributor

Is it a requirement to put annotation class top level?

@srowen
Copy link
Member Author

srowen commented Nov 20, 2018

Yeah, or at least so claims Scala 2.12. Java evidently doesn't object.

jackylee-ch pushed a commit to jackylee-ch/spark that referenced this pull request Feb 18, 2019
## What changes were proposed in this pull request?

This restores scaladoc artifact generation, which got dropped with the Scala 2.12 update. The change looks large, but is almost all due to needing to make the InterfaceStability annotations top-level classes (i.e. `InterfaceStability.Stable` -> `Stable`), unfortunately. A few inner class references had to be qualified too.

Lots of scaladoc warnings now reappear. We can choose to disable generation by default and enable for releases, later.

## How was this patch tested?

N/A; build runs scaladoc now.

Closes apache#23069 from srowen/SPARK-26026.

Authored-by: Sean Owen <[email protected]>
Signed-off-by: Sean Owen <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants