[
https://issues.apache.org/jira/browse/SPARK-39253?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Haejoon Lee updated SPARK-39253:
--------------------------------
Description:
Currently, the PySpark documentation especially ["Spark SQL"
part|https://spark.apache.org/docs/latest/api/python/reference/pyspark.sql.html#]
is not-well organized so it's a bit uncomfortable to be read.
For example, the
[pyspark.sql.SparkSession|https://spark.apache.org/docs/latest/api/python/reference/api/pyspark.sql.SparkSession.html]
class shows every available method its sub-contents, but
pyspark.sql.DataFrameReader doesn't have it's own top-level class page, and
also its available methods.
So we might need to refine the document to make it more readable so that users
can easily find the methods they want.
was:
Currently, the PySpark documentation especially ["Spark SQL"
part|https://spark.apache.org/docs/latest/api/python/reference/pyspark.sql.html#]
is not-well organized so it's a bit uncomfortable to be read.
For example, the
[pyspark.sql.SparkSession|https://spark.apache.org/docs/latest/api/python/reference/api/pyspark.sql.SparkSession.html]
class shows every available method its sub-contents, but
pyspark.sql.DataFrameReader doesn't have it's own top-level class page, and
also its available methods.
We might need to refine the document to make it more readable so that users can
easily find the methods they want.
> Improve PySpark API reference to be more readable
> -------------------------------------------------
>
> Key: SPARK-39253
> URL: https://issues.apache.org/jira/browse/SPARK-39253
> Project: Spark
> Issue Type: Test
> Components: Documentation, PySpark
> Affects Versions: 3.3.0
> Reporter: Haejoon Lee
> Priority: Major
>
> Currently, the PySpark documentation especially ["Spark SQL"
> part|https://spark.apache.org/docs/latest/api/python/reference/pyspark.sql.html#]
> is not-well organized so it's a bit uncomfortable to be read.
> For example, the
> [pyspark.sql.SparkSession|https://spark.apache.org/docs/latest/api/python/reference/api/pyspark.sql.SparkSession.html]
> class shows every available method its sub-contents, but
> pyspark.sql.DataFrameReader doesn't have it's own top-level class page, and
> also its available methods.
> So we might need to refine the document to make it more readable so that
> users can easily find the methods they want.
--
This message was sent by Atlassian Jira
(v8.20.7#820007)
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscr...@spark.apache.org
For additional commands, e-mail: issues-h...@spark.apache.org
