This is an automated email from the ASF dual-hosted git repository.
gurwls223 pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/spark.git
The following commit(s) were added to refs/heads/master by this push:
new a0ffb2e7f6a0 [MINOR][DOCS][CONNECT] Update notes about supported
modules in PySpark API reference
a0ffb2e7f6a0 is described below
commit a0ffb2e7f6a0e6f60c2f512507a23f2baa794dde
Author: Hyukjin Kwon <[email protected]>
AuthorDate: Thu Sep 21 09:39:19 2023 +0900
[MINOR][DOCS][CONNECT] Update notes about supported modules in PySpark API
reference
### What changes were proposed in this pull request?
This PR proposes to add a couple of notes about which modules are supported
by Spark Connect.
### Why are the changes needed?
In order for users to explicitly know which ones are supported in PySpark
with Spark Connect.
### Does this PR introduce _any_ user-facing change?
Yes, this exposes some notes for PySpark API with Spark Connect.
### How was this patch tested?
Manually built the site, and checked.
### Was this patch authored or co-authored using generative AI tooling?
No.
Closes #43013 from HyukjinKwon/minor-docs-py.
Authored-by: Hyukjin Kwon <[email protected]>
Signed-off-by: Hyukjin Kwon <[email protected]>
---
python/docs/source/reference/index.rst | 4 +++-
python/docs/source/reference/pyspark.pandas/index.rst | 3 +++
python/docs/source/reference/pyspark.sql/functions.rst | 4 +++-
3 files changed, 9 insertions(+), 2 deletions(-)
diff --git a/python/docs/source/reference/index.rst
b/python/docs/source/reference/index.rst
index ed3eb4d07dac..668601105e12 100644
--- a/python/docs/source/reference/index.rst
+++ b/python/docs/source/reference/index.rst
@@ -22,7 +22,9 @@ API Reference
This page lists an overview of all public PySpark modules, classes, functions
and methods.
-Pandas API on Spark follows the API specifications of latest pandas release.
+.. note::
+ Spark SQL, Pandas API on Spark, Structured Streaming, and MLlib
(DataFrame-based) support
+ Spark Connect.
.. toctree::
:maxdepth: 2
diff --git a/python/docs/source/reference/pyspark.pandas/index.rst
b/python/docs/source/reference/pyspark.pandas/index.rst
index 96da0869a0cd..31fc95e95f10 100644
--- a/python/docs/source/reference/pyspark.pandas/index.rst
+++ b/python/docs/source/reference/pyspark.pandas/index.rst
@@ -22,6 +22,9 @@ Pandas API on Spark
This page gives an overview of all public pandas API on Spark.
+.. note::
+ pandas API on Spark follows the API specifications of latest pandas release.
+
.. toctree::
:maxdepth: 2
diff --git a/python/docs/source/reference/pyspark.sql/functions.rst
b/python/docs/source/reference/pyspark.sql/functions.rst
index e21c05343da5..43615d690e8b 100644
--- a/python/docs/source/reference/pyspark.sql/functions.rst
+++ b/python/docs/source/reference/pyspark.sql/functions.rst
@@ -22,7 +22,9 @@ Functions
.. currentmodule:: pyspark.sql.functions
A collections of builtin functions available for DataFrame operations.
-From Apache Spark 3.5.0, all functions support Spark Connect.
+
+.. note::
+ From Apache Spark 3.5.0, all functions support Spark Connect.
Normal Functions
----------------
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
