You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@spark.apache.org by ru...@apache.org on 2023/03/08 04:47:15 UTC

[spark] branch branch-3.4 updated: [SPARK-42707][CONNECT][DOCS] Update developer documentation about API stability warning

This is an automated email from the ASF dual-hosted git repository.

ruifengz pushed a commit to branch branch-3.4
in repository https://gitbox.apache.org/repos/asf/spark.git


The following commit(s) were added to refs/heads/branch-3.4 by this push:
     new 824b78a9b10 [SPARK-42707][CONNECT][DOCS] Update developer documentation about API stability warning
824b78a9b10 is described below

commit 824b78a9b1024a29098cad5671caf7fb1cf8efda
Author: Hyukjin Kwon <gu...@apache.org>
AuthorDate: Wed Mar 8 12:46:39 2023 +0800

    [SPARK-42707][CONNECT][DOCS] Update developer documentation about API stability warning
    
    ### What changes were proposed in this pull request?
    
    This PR updates the developer documentation by removing the warnings about API compatibility.
    
    ### Why are the changes needed?
    
    We actually are going to keep the compatibility there. Such warnings cause a misconception that we can just break the compatibility there.
    
    ### Does this PR introduce _any_ user-facing change?
    
    No, it's developer-only docs.
    
    ### How was this patch tested?
    
    Linters in CI should test it out.
    
    Closes #40325 from HyukjinKwon/SPARK-42707.
    
    Lead-authored-by: Hyukjin Kwon <gu...@apache.org>
    Co-authored-by: Hyukjin Kwon <gu...@gmail.com>
    Signed-off-by: Ruifeng Zheng <ru...@apache.org>
    (cherry picked from commit b63c11cf110b3c31725eac1a43f24277d665d2b8)
    Signed-off-by: Ruifeng Zheng <ru...@apache.org>
---
 connector/connect/README.md            | 3 ---
 python/pyspark/sql/connect/__init__.py | 3 +--
 2 files changed, 1 insertion(+), 5 deletions(-)

diff --git a/connector/connect/README.md b/connector/connect/README.md
index 6567daf5504..dfe49cea3df 100644
--- a/connector/connect/README.md
+++ b/connector/connect/README.md
@@ -1,8 +1,5 @@
 # Spark Connect
 
-**Spark Connect is a strictly experimental feature and under heavy development.
-All APIs should be considered volatile and should not be used in production.**
-
 This module contains the implementation of Spark Connect which is a logical plan
 facade for the implementation in Spark. Spark Connect is directly integrated into the build
 of Spark.
diff --git a/python/pyspark/sql/connect/__init__.py b/python/pyspark/sql/connect/__init__.py
index 9bd4513db22..93236e8294f 100644
--- a/python/pyspark/sql/connect/__init__.py
+++ b/python/pyspark/sql/connect/__init__.py
@@ -15,5 +15,4 @@
 # limitations under the License.
 #
 
-"""Currently Spark Connect is very experimental and the APIs to interact with
-Spark through this API are can be changed at any time without warning."""
+"""Spark Connect client"""


---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@spark.apache.org
For additional commands, e-mail: commits-help@spark.apache.org