update

apache · Oct 18, 2022 · 5ce1d17 · 5ce1d17
1 parent 8c89c79
commit 5ce1d17
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/python/pyspark/sql/connect/plan.py b/python/pyspark/sql/connect/plan.py
@@ -83,6 +83,16 @@ def _verify(self, session: "RemoteSparkSession") -> bool:
     def to_proto(
         self, session: Optional["RemoteSparkSession"] = None, debug: bool = False
     ) -> proto.Plan:
+        """
+        Generates connect proto plan based on this LogicalPlan.
+
+        Parameters
+        ----------
+        session : :class:`RemoteSparkSession`, optional.
+            a session that connects remote spark cluster.
+        debug: bool
+            if enabled, the proto plan will be printed.
+        """
         plan = proto.Plan()
         plan.root.CopyFrom(self.plan(session))