aboutsummaryrefslogtreecommitdiff
path: root/python/pyspark/conf.py
diff options
context:
space:
mode:
authorDavies Liu <davies.liu@gmail.com>2014-10-07 18:09:27 -0700
committerJosh Rosen <joshrosen@apache.org>2014-10-07 18:09:27 -0700
commit798ed22c289cf65f2249bf2f4250285685ca69e7 (patch)
tree137d93c32454aaf39e6416823a8604f816f73926 /python/pyspark/conf.py
parentb69c9fb6fb048509bbd8430fb697dc3a5ca4fe59 (diff)
downloadspark-798ed22c289cf65f2249bf2f4250285685ca69e7.tar.gz
spark-798ed22c289cf65f2249bf2f4250285685ca69e7.tar.bz2
spark-798ed22c289cf65f2249bf2f4250285685ca69e7.zip
[SPARK-3412] [PySpark] Replace Epydoc with Sphinx to generate Python API docs
Retire Epydoc, use Sphinx to generate API docs. Refine Sphinx docs, also convert some docstrings into Sphinx style. It looks like: ![api doc](https://cloud.githubusercontent.com/assets/40902/4538272/9e2d4f10-4dec-11e4-8d96-6e45a8fe51f9.png) Author: Davies Liu <davies.liu@gmail.com> Closes #2689 from davies/docs and squashes the following commits: bf4a0a5 [Davies Liu] fix links 3fb1572 [Davies Liu] fix _static in jekyll 65a287e [Davies Liu] fix scripts and logo 8524042 [Davies Liu] Merge branch 'master' of github.com:apache/spark into docs d5b874a [Davies Liu] Merge branch 'master' of github.com:apache/spark into docs 4bc1c3c [Davies Liu] refactor 746d0b6 [Davies Liu] @param -> :param 240b393 [Davies Liu] replace epydoc with sphinx doc
Diffstat (limited to 'python/pyspark/conf.py')
-rw-r--r--python/pyspark/conf.py8
1 files changed, 4 insertions, 4 deletions
diff --git a/python/pyspark/conf.py b/python/pyspark/conf.py
index b64875a3f4..dc7cd0bce5 100644
--- a/python/pyspark/conf.py
+++ b/python/pyspark/conf.py
@@ -83,11 +83,11 @@ class SparkConf(object):
"""
Create a new Spark configuration.
- @param loadDefaults: whether to load values from Java system
+ :param loadDefaults: whether to load values from Java system
properties (True by default)
- @param _jvm: internal parameter used to pass a handle to the
+ :param _jvm: internal parameter used to pass a handle to the
Java VM; does not need to be set by users
- @param _jconf: Optionally pass in an existing SparkConf handle
+ :param _jconf: Optionally pass in an existing SparkConf handle
to use its parameters
"""
if _jconf:
@@ -139,7 +139,7 @@ class SparkConf(object):
"""
Set multiple parameters, passed as a list of key-value pairs.
- @param pairs: list of key-value pairs to set
+ :param pairs: list of key-value pairs to set
"""
for (k, v) in pairs:
self._jconf.set(k, v)