Updated comments use correct sample code for Dataframe joins

Paul Power · Paul Power · commit e35334043148 · 2015-03-01T22:41:35.000-08:00
The API signatire for join requires the JoinType to be the third parameter. The code examples provided for join show JoinType being provided as the 2nd parater resuling in errors (i.e. "df1.join(df2, "outer", $"df1Key" === $"df2Key") ). The correct example should be df1.join(df2, $"df1Key" === $"df2Key", "outer")
diff --git a/sql/core/src/main/scala/org/apache/spark/sql/DataFrame.scala b/sql/core/src/main/scala/org/apache/spark/sql/DataFrame.scala
@@ -337,11 +337,11 @@ class DataFrame protected[sql](
    * {{{
    *   // Scala:
    *   import org.apache.spark.sql.functions._
-   *   df1.join(df2, "outer", $"df1Key" === $"df2Key")
+   *   df1.join(df2, $"df1Key" === $"df2Key", "outer")
    *
    *   // Java:
    *   import static org.apache.spark.sql.functions.*;
-   *   df1.join(df2, "outer", col("df1Key") === col("df2Key"));
+   *   df1.join(df2, col("df1Key") === col("df2Key"), "outer");
    * }}}
    *
    * @param right Right side of the join.

Original file line number	Diff line number	Diff line change
`@@ -337,11 +337,11 @@ class DataFrame protected[sql](`
`337`	`337`	`* {{{`
`338`	`338`	`* // Scala:`
`339`	`339`	`* import org.apache.spark.sql.functions._`
`340`		`- * df1.join(df2, "outer", $"df1Key" === $"df2Key")`
	`340`	`+ * df1.join(df2, $"df1Key" === $"df2Key", "outer")`
`341`	`341`	`*`
`342`	`342`	`* // Java:`
`343`	`343`	`* import static org.apache.spark.sql.functions.*;`
`344`		`- * df1.join(df2, "outer", col("df1Key") === col("df2Key"));`
	`344`	`+ * df1.join(df2, col("df1Key") === col("df2Key"), "outer");`
`345`	`345`	`* }}}`
`346`	`346`	`*`
`347`	`347`	`* @param right Right side of the join.`