[DOCS][MINOR] Scaladoc fixes (aka typo hunting) by jaceklaskowski · Pull Request #18074 · apache/spark

jaceklaskowski · 2017-05-23T15:00:19Z

What changes were proposed in this pull request?

Minor changes to scaladoc

How was this patch tested?

Local build

srowen · 2017-05-23T15:08:57Z


  /**
-   * Return all metadata that describes more details of this SparkPlan.
+   * Returns all metadata that describes more details of this SparkPlan.


You can even turn this into @return but no big deal.

srowen · 2017-05-23T15:09:18Z

 *
- * The main method is the agg function, which has multiple variants. This class also contains
- * convenience some first order statistics such as mean, sum for convenience.
+ * The main method is the [[agg]] function, which has multiple variants. This class also contains


These look fine but have you had a chance to run the doc generation, to make sure scaladoc is OK with it?

No scaladoc. I was focused on javadoc and seems I missed it. Fixed.

SparkQA · 2017-05-23T17:24:57Z

Test build #77255 has finished for PR 18074 at commit 5a7eac8.

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

SparkQA · 2017-05-25T07:22:37Z

Test build #77347 has finished for PR 18074 at commit 6a95691.

This patch fails to build.
This patch merges cleanly.
This patch adds no public classes.

SparkQA · 2017-05-25T10:09:48Z

Test build #77348 has finished for PR 18074 at commit 9479ccc.

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

srowen · 2017-05-25T10:13:36Z

    // Add a function and its function to the map for a given frame.
-    def collect(tpe: String, fr: SpecifiedWindowFrame, e: Expression, fn: Expression): Unit = {
+    def collect(
+      tpe: String, fr: SpecifiedWindowFrame, e: WindowExpression, fn: Expression): Unit =


This changed a type, which could be fine as it's an internal method, but why should it be the more specific type? this isn't a doc change

I'll revert it to not "pollute" the PR. It was much easier to read the code when the internals were less generic (that does nothing at all).

SparkQA · 2017-05-25T10:25:11Z

Test build #77352 has finished for PR 18074 at commit 10104f2.

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

SparkQA · 2017-05-27T20:11:30Z

Test build #77471 has finished for PR 18074 at commit 59bf972.

This patch fails PySpark unit tests.
This patch merges cleanly.
This patch adds the following public classes (experimental):
class HasMinSupport(Params):
class HasNumPartitions(Params):
class HasMinConfidence(Params):
case class Chr(child: Expression) extends UnaryExpression with ImplicitCastInputTypes
case class AnalysisBarrier(child: LogicalPlan) extends LeafNode

SparkQA · 2017-05-27T23:09:26Z

Test build #3766 has finished for PR 18074 at commit 59bf972.

This patch passes all tests.
This patch merges cleanly.
This patch adds the following public classes (experimental):
class HasMinSupport(Params):
class HasNumPartitions(Params):
class HasMinConfidence(Params):
case class Chr(child: Expression) extends UnaryExpression with ImplicitCastInputTypes
case class AnalysisBarrier(child: LogicalPlan) extends LeafNode

SparkQA · 2017-05-28T22:19:03Z

Test build #77491 has finished for PR 18074 at commit a95cba0.

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

jaceklaskowski · 2017-05-29T07:30:08Z

Hey @srowen could you review the changes again and accept possibly? Thanks!

SparkQA · 2017-05-29T11:41:01Z

Test build #77500 has finished for PR 18074 at commit 379e775.

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

srowen · 2017-05-30T11:23:08Z

  private[this] lazy val windowFrameExpressionFactoryPairs = {
    type FrameKey = (String, FrameType, Option[Int], Option[Int])
    type ExpressionBuffer = mutable.Buffer[Expression]
+    type WindowExpressionBuffer = mutable.Buffer[WindowExpression]


@jaceklaskowski this is still not reverted. Please, back out any non-doc changes. I can't spend 4 rounds of review on things like this, it's not fair to anyone else waiting

Sorry. Reverted the change manually and looks like it slipped through the cracks. Apologies.

SparkQA · 2017-05-30T20:14:30Z

Test build #77543 has finished for PR 18074 at commit 2a02302.

This patch passes all tests.
This patch merges cleanly.
This patch adds the following public classes (experimental):
case class UnresolvedRelation(
case class StringReplace(srcExpr: Expression, searchExpr: Expression, replaceExpr: Expression)

srowen · 2017-05-31T10:24:43Z

Merged to master

[DOCS][MINOR] Scaladoc fixes (aka typo hunting)

5a7eac8

srowen approved these changes May 23, 2017

View reviewed changes

jaceklaskowski added 2 commits May 25, 2017 09:12

Merge remote-tracking branch 'origin/master' into scaladoc-fixes

788fea0

More scaladoc fixes + explicit type for internal lazy value

6a95691

jaceklaskowski added 3 commits May 25, 2017 09:34

Fix types for windowFrameExpressionFactoryPairs

ee9d006

Another typo

9479ccc

After review

10104f2

srowen reviewed May 25, 2017

View reviewed changes

jaceklaskowski added 2 commits May 27, 2017 20:21

After review (reverting changes)

d853b97

Merge remote-tracking branch 'origin/master' into scaladoc-fixes

59bf972

Scaladoc

a95cba0

Another typo hunted

379e775

srowen reviewed May 30, 2017

View reviewed changes

jaceklaskowski added 2 commits May 30, 2017 19:51

Reverting non-scaladoc changes

a79fa0a

Merge remote-tracking branch 'origin/master' into scaladoc-fixes

2a02302

asfgit closed this in beed5e2 May 31, 2017

jaceklaskowski deleted the scaladoc-fixes branch May 31, 2017 11:56

Conversation

jaceklaskowski commented May 23, 2017

What changes were proposed in this pull request?

How was this patch tested?

Uh oh!

srowen May 23, 2017

Choose a reason for hiding this comment

Uh oh!

srowen May 23, 2017

Choose a reason for hiding this comment

Uh oh!

jaceklaskowski May 25, 2017

Choose a reason for hiding this comment

Uh oh!

SparkQA commented May 23, 2017

Uh oh!

SparkQA commented May 25, 2017

Uh oh!

SparkQA commented May 25, 2017

Uh oh!

srowen May 25, 2017

Choose a reason for hiding this comment

Uh oh!

jaceklaskowski May 26, 2017

Choose a reason for hiding this comment

Uh oh!

SparkQA commented May 25, 2017

Uh oh!

SparkQA commented May 27, 2017

Uh oh!

SparkQA commented May 27, 2017

Uh oh!

SparkQA commented May 28, 2017

Uh oh!

jaceklaskowski commented May 29, 2017

Uh oh!

SparkQA commented May 29, 2017

Uh oh!

srowen May 30, 2017

Choose a reason for hiding this comment

Uh oh!

jaceklaskowski May 30, 2017

Choose a reason for hiding this comment

Uh oh!

SparkQA commented May 30, 2017

Uh oh!

srowen commented May 31, 2017

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants