aa88b8dbbb
## 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. ![screen](https://user-images.githubusercontent.com/9700541/32705514-1bdcafaa-c7ca-11e7-88bf-05566fea42de.png) The following is the diff of the generated result. ``` $ diff old.html new.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>A class attribute having a <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> to construct <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"> = <pyspark.sql.session.SparkSession.Builder object></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 ``` Author: Dongjoon Hyun <dongjoon@apache.org> Closes #19726 from dongjoon-hyun/SPARK-22490.
31 lines
660 B
ReStructuredText
31 lines
660 B
ReStructuredText
pyspark.sql module
|
|
==================
|
|
|
|
Module Context
|
|
--------------
|
|
|
|
.. automodule:: pyspark.sql
|
|
:members:
|
|
:undoc-members:
|
|
:exclude-members: builder
|
|
.. We need `exclude-members` to prevent default description generations
|
|
as a workaround for old Sphinx (< 1.6.6).
|
|
|
|
pyspark.sql.types module
|
|
------------------------
|
|
.. automodule:: pyspark.sql.types
|
|
:members:
|
|
:undoc-members:
|
|
|
|
pyspark.sql.functions module
|
|
----------------------------
|
|
.. automodule:: pyspark.sql.functions
|
|
:members:
|
|
:undoc-members:
|
|
|
|
pyspark.sql.streaming module
|
|
----------------------------
|
|
.. automodule:: pyspark.sql.streaming
|
|
:members:
|
|
:undoc-members:
|