GitHub user mengxr opened a pull request:

    https://github.com/apache/spark/pull/22137

    [MINOR][DOC][SQL] use one line for annotation arg value

    ## What changes were proposed in this pull request?
    
    Put annotation args in one line, or API doc generation will fail.
    
    ~~~
    [error] 
/Users/meng/src/spark/sql/catalyst/src/main/scala/org/apache/spark/sql/catalyst/expressions/stringExpressions.scala:1559:
 annotation argument needs to be a constant; found: "_FUNC_(expr) - Returns the 
character length of string data or number of bytes of ".+("binary data. The 
length of string data includes the trailing spaces. The length of binary 
").+("data includes binary zeros.")
    [error]     "binary data. The length of string data includes the trailing 
spaces. The length of binary " +
    [error]                                                                     
                             ^
    [info] No documentation generated with unsuccessful compiler run
    [error] one error found
    [error] (catalyst/compile:doc) Scaladoc generation failed
    [error] Total time: 27 s, completed Aug 17, 2018 3:20:08 PM
    ~~~
    
    ## How was this patch tested?
    
    sbt catalyst/compile:doc passed
    


You can merge this pull request into a Git repository by running:

    $ git pull https://github.com/mengxr/spark minor-doc-fix

Alternatively you can review and apply these changes as the patch at:

    https://github.com/apache/spark/pull/22137.patch

To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:

    This closes #22137
    
----
commit e9a93762aeeb219cf9ab600da248a0d1f295d09f
Author: Xiangrui Meng <meng@...>
Date:   2018-08-17T22:47:04Z

    fix a minor issue to generate API docs

----


---

---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]

Reply via email to