-
- Downloads
[SPARK-16772] Correct API doc references to PySpark classes + formatting fixes
## What's Been Changed The PR corrects several broken or missing class references in the Python API docs. It also correct formatting problems. For example, you can see [here](http://spark.apache.org/docs/2.0.0/api/python/pyspark.sql.html#pyspark.sql.SQLContext.registerFunction) how Sphinx is not picking up the reference to `DataType`. That's because the reference is relative to the current module, whereas `DataType` is in a different module. You can also see [here](http://spark.apache.org/docs/2.0.0/api/python/pyspark.sql.html#pyspark.sql.SQLContext.createDataFrame) how the formatting for byte, tinyint, and so on is italic instead of monospace. That's because in ReST single backticks just make things italic, unlike in Markdown. ## Testing I tested this PR by [building the Python docs](https://github.com/apache/spark/tree/master/docs#generating-the-documentation-html) and reviewing the results locally in my browser. I confirmed that the broken or missing class references were resolved, and that the formatting was corrected. Author: Nicholas Chammas <nicholas.chammas@gmail.com> Closes #14393 from nchammas/python-docstring-fixes.
Showing
- python/pyspark/sql/catalog.py 1 addition, 1 deletionpython/pyspark/sql/catalog.py
- python/pyspark/sql/context.py 25 additions, 19 deletionspython/pyspark/sql/context.py
- python/pyspark/sql/dataframe.py 1 addition, 1 deletionpython/pyspark/sql/dataframe.py
- python/pyspark/sql/functions.py 13 additions, 8 deletionspython/pyspark/sql/functions.py
- python/pyspark/sql/readwriter.py 4 additions, 4 deletionspython/pyspark/sql/readwriter.py
- python/pyspark/sql/session.py 23 additions, 18 deletionspython/pyspark/sql/session.py
- python/pyspark/sql/streaming.py 4 additions, 4 deletionspython/pyspark/sql/streaming.py
- python/pyspark/sql/types.py 4 additions, 3 deletionspython/pyspark/sql/types.py
Loading
Please register or sign in to comment