Skip to content

[SPARK-46282][PYTHON][DOCS] Rename "Spark SQL" page to "DataFrame API"#44766

Closed
itholic wants to merge 4 commits intoapache:masterfrom
itholic:rename_spark_sql_docs
Closed

[SPARK-46282][PYTHON][DOCS] Rename "Spark SQL" page to "DataFrame API"#44766
itholic wants to merge 4 commits intoapache:masterfrom
itholic:rename_spark_sql_docs

Conversation

@itholic
Copy link
Contributor

@itholic itholic commented Jan 17, 2024

What changes were proposed in this pull request?

This PR proposes to rename "Spark SQL" page to "DataFrame API".

This includes updating the title and any relevant references within the documentation to better highlight the centrality of the DataFrame API in PySpark.

This also includes adding SQL Reference related descriptions and links to the pyspark.sql.SparkSession.sql API to make it easier for users to use SQL supported by Spark.

Why are the changes needed?

The change is needed to more accurately represent the content of the page, which primarily focuses on the DataFrame API – a key aspect of PySpark. Renaming the page to "DataFrame API" emphasizes its importance and utility in the PySpark ecosystem, making the documentation more intuitive and aligned with the common usage and understanding of PySpark's core functionalities.

Does this PR introduce any user-facing change?

No API changes, but user-facing documentation will be updated:

Main

Screenshot 2024-01-17 at 3 24 46 PM

API Reference

Screenshot 2024-01-17 at 4 04 52 PM

SparkSession.sql

Screenshot 2024-01-17 at 3 54 23 PM

How was this patch tested?

Manually build docs.

Was this patch authored or co-authored using generative AI tooling?

No.

@itholic
Copy link
Contributor Author

itholic commented Jan 30, 2024

Let me close this ticket for now as it seems to be need further discussion.

@itholic itholic closed this Jan 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant

Comments