ODIn/spark-instrumented-optimizer
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity
spark-instrumented-optimizer/python/pyspark/mllib
History
cocoatomo 2300eb58ae [SPARK-3773][PySpark][Doc] Sphinx build warning 
When building Sphinx documents for PySpark, we have 12 warnings.
Their causes are almost docstrings in broken ReST format.

To reproduce this issue, we should run following commands on the commit: 6e27cb630d.

```bash
$ cd ./python/docs
$ make clean html
...
/Users/<user>/MyRepos/Scala/spark/python/pyspark/__init__.py:docstring of pyspark.SparkContext.sequenceFile:4: ERROR: Unexpected indentation.
/Users/<user>/MyRepos/Scala/spark/python/pyspark/__init__.py:docstring of pyspark.RDD.saveAsSequenceFile:4: ERROR: Unexpected indentation.
/Users/<user>/MyRepos/Scala/spark/python/pyspark/mllib/classification.py:docstring of pyspark.mllib.classification.LogisticRegressionWithSGD.train:14: ERROR: Unexpected indentation.
/Users/<user>/MyRepos/Scala/spark/python/pyspark/mllib/classification.py:docstring of pyspark.mllib.classification.LogisticRegressionWithSGD.train:16: WARNING: Definition list ends without a blank line; unexpected unindent.
/Users/<user>/MyRepos/Scala/spark/python/pyspark/mllib/classification.py:docstring of pyspark.mllib.classification.LogisticRegressionWithSGD.train:17: WARNING: Block quote ends without a blank line; unexpected unindent.
/Users/<user>/MyRepos/Scala/spark/python/pyspark/mllib/classification.py:docstring of pyspark.mllib.classification.SVMWithSGD.train:14: ERROR: Unexpected indentation.
/Users/<user>/MyRepos/Scala/spark/python/pyspark/mllib/classification.py:docstring of pyspark.mllib.classification.SVMWithSGD.train:16: WARNING: Definition list ends without a blank line; unexpected unindent.
/Users/<user>/MyRepos/Scala/spark/python/pyspark/mllib/classification.py:docstring of pyspark.mllib.classification.SVMWithSGD.train:17: WARNING: Block quote ends without a blank line; unexpected unindent.
/Users/<user>/MyRepos/Scala/spark/python/docs/pyspark.mllib.rst:50: WARNING: missing attribute mentioned in :members: or __all__: module pyspark.mllib.regression, attribute RidgeRegressionModelLinearRegressionWithSGD
/Users/<user>/MyRepos/Scala/spark/python/pyspark/mllib/tree.py:docstring of pyspark.mllib.tree.DecisionTreeModel.predict:3: ERROR: Unexpected indentation.
...
checking consistency... /Users/<user>/MyRepos/Scala/spark/python/docs/modules.rst:: WARNING: document isn't included in any toctree
...
copying static files... WARNING: html_static_path entry u'/Users/<user>/MyRepos/Scala/spark/python/docs/_static' does not exist
...
build succeeded, 12 warnings.
```

Author: cocoatomo <cocoatomo77@gmail.com>

Closes #2653 from cocoatomo/issues/3773-sphinx-build-warnings and squashes the following commits:

6f65661 [cocoatomo] [SPARK-3773][PySpark][Doc] Sphinx build warning
2014-10-06 14:08:40 -07:00
..
__init__.py SPARK-1426: Make MLlib work with NumPy versions older than 1.7 2014-04-15 00:19:43 -07:00
classification.py [SPARK-3773][PySpark][Doc] Sphinx build warning 2014-10-06 14:08:40 -07:00
clustering.py [SPARK-3491] [MLlib] [PySpark] use pickle to serialize data in MLlib 2014-09-19 15:01:11 -07:00
linalg.py [SPARK-3701][MLLIB] update python linalg api and small fixes 2014-09-30 17:10:36 -07:00
random.py [SPARK-3491] [MLlib] [PySpark] use pickle to serialize data in MLlib 2014-09-19 15:01:11 -07:00
recommendation.py [SPARK-3491] [MLlib] [PySpark] use pickle to serialize data in MLlib 2014-09-19 15:01:11 -07:00
regression.py [SPARK-3773][PySpark][Doc] Sphinx build warning 2014-10-06 14:08:40 -07:00
stat.py [SPARK-3491] [MLlib] [PySpark] use pickle to serialize data in MLlib 2014-09-19 15:01:11 -07:00
tests.py [SPARK-3786] [PySpark] speedup tests 2014-10-06 14:07:53 -07:00
tree.py [SPARK-3773][PySpark][Doc] Sphinx build warning 2014-10-06 14:08:40 -07:00
util.py [SPARK-3491] [MLlib] [PySpark] use pickle to serialize data in MLlib 2014-09-19 15:01:11 -07:00