GitHub user dongjoon-hyun opened a pull request:

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

    [SPARK-22490][DOC] Add PySpark doc for SparkSession.builder

    ## What changes were proposed in this pull request?
    
    In PySpark API Document, 
[SparkSession.build](http://spark.apache.org/docs/2.2.0/api/python/pyspark.sql.html)
 is not documented and shows default value description.
    ```
    SparkSession.builder = <pyspark.sql.session.Builder object ...
    ```
    This PR adds the doc. The following is the diff of the generated result.
    
    ```
    $ diff new.html old.html
    95a96,101
    > <dl class="attribute">
    > <dt id="pyspark.sql.SparkSession.builder">
    > <code class="descname">builder</code><a class="headerlink" 
href="#pyspark.sql.SparkSession.builder" title="Permalink to this 
definition">¶</a></dt>
    > <dd><p>class variable for <a class="reference internal" 
href="#pyspark.sql.SparkSession.Builder" 
title="pyspark.sql.SparkSession.Builder"><code class="xref py py-class docutils 
literal"><span class="pre">Builder</span></code></a> shared by all <a 
class="reference internal" href="#pyspark.sql.SparkSession" 
title="pyspark.sql.SparkSession"><code class="xref py py-class docutils 
literal"><span class="pre">SparkSession</span></code></a> instances</p>
    > </dd></dl>
    >
    212,216d217
    < <dt id="pyspark.sql.SparkSession.builder">
    < <code class="descname">builder</code><em class="property"> = 
&lt;pyspark.sql.session.SparkSession.Builder object&gt;</em><a 
class="headerlink" href="#pyspark.sql.SparkSession.builder" title="Permalink to 
this definition">¶</a></dt>
    < <dd></dd></dl>
    <
    < <dl class="attribute">
    ```
    
    ## How was this patch tested?
    
    Manual.
    
    ```
    cd python/docs
    make html
    open _build/html/pyspark.sql.html
    ```

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

    $ git pull https://github.com/dongjoon-hyun/spark SPARK-22490

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

    https://github.com/apache/spark/pull/19726.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 #19726
    
----
commit fd93eac787470aef5387b570a3d6b809a637abf5
Author: Dongjoon Hyun <[email protected]>
Date:   2017-11-12T11:26:06Z

    [SPARK-22490][DOC] Add PySpark doc for SparkSession.builder

----


---

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

Reply via email to