[SQL][DOC] Fix documentation of lpad

actuaryzhang · srowen · commit d6257347122a · 2017-06-22T10:12:42.000+01:00
## What changes were proposed in this pull request? Fix incomplete documentation for `lpad`. Author: actuaryzhang <actuaryzhang10@gmail.com> Closes apache#18367 from actuaryzhang/SQLDoc. (cherry picked from commit 97b307c) Signed-off-by: Sean Owen <sowen@cloudera.com>
diff --git a/sql/core/src/main/scala/org/apache/spark/sql/functions.scala b/sql/core/src/main/scala/org/apache/spark/sql/functions.scala
@@ -2292,7 +2292,8 @@ object functions {
   }
 
   /**
-   * Left-pad the string column with
+   * Left-pad the string column with pad to a length of len. If the string column is longer
+   * than len, the return value is shortened to len characters.
    *
    * @group string_funcs
    * @since 1.5.0
@@ -2350,7 +2351,8 @@ object functions {
   def unbase64(e: Column): Column = withExpr { UnBase64(e.expr) }
 
   /**
-   * Right-padded with pad to a length of len.
+   * Right-pad the string column with pad to a length of len. If the string column is longer
+   * than len, the return value is shortened to len characters.
    *
    * @group string_funcs
    * @since 1.5.0

Original file line number	Diff line number	Diff line change
`@@ -2292,7 +2292,8 @@ object functions {`
`2292`	`2292`	`}`
`2293`	`2293`
`2294`	`2294`	`/**`
`2295`		`- * Left-pad the string column with`
	`2295`	`+ * Left-pad the string column with pad to a length of len. If the string column is longer`
	`2296`	`+ * than len, the return value is shortened to len characters.`
`2296`	`2297`	`*`
`2297`	`2298`	`* @group string_funcs`
`2298`	`2299`	`* @since 1.5.0`
`@@ -2350,7 +2351,8 @@ object functions {`
`2350`	`2351`	`def unbase64(e: Column): Column = withExpr { UnBase64(e.expr) }`
`2351`	`2352`
`2352`	`2353`	`/**`
`2353`		`- * Right-padded with pad to a length of len.`
	`2354`	`+ * Right-pad the string column with pad to a length of len. If the string column is longer`
	`2355`	`+ * than len, the return value is shortened to len characters.`
`2354`	`2356`	`*`
`2355`	`2357`	`* @group string_funcs`
`2356`	`2358`	`* @since 1.5.0`