Skip to content

Commit

Permalink
[SPARK-48638][FOLLOW][CONNECT] Fix documentation for ExecutionInfo
Browse files Browse the repository at this point in the history
### What changes were proposed in this pull request?
A previous renaming of the method and class names left the documentation out of sync. This patch fixes this.

### Why are the changes needed?
Consistency.

### Does this PR introduce _any_ user-facing change?
No

### How was this patch tested?
Existing tests.

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

Closes #47829 from grundprinzip/SPARK-48638-v2.

Authored-by: Martin Grund <martin.grund@databricks.com>
Signed-off-by: Martin Grund <martin.grund@databricks.com>
  • Loading branch information
grundprinzip committed Aug 21, 2024
1 parent 37f93e5 commit 99b7939
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
6 changes: 3 additions & 3 deletions python/pyspark/sql/dataframe.py
Original file line number Diff line number Diff line change
Expand Up @@ -6326,9 +6326,9 @@ def toPandas(self) -> "PandasDataFrameLike":
@property
def executionInfo(self) -> Optional["ExecutionInfo"]:
"""
Returns a QueryExecution object after the query was executed.
Returns a ExecutionInfo object after the query was executed.
The queryExecution method allows to introspect information about the actual
The executionInfo method allows to introspect information about the actual
query execution after the successful execution. Accessing this member before
the query execution will return None.
Expand All @@ -6339,7 +6339,7 @@ def executionInfo(self) -> Optional["ExecutionInfo"]:
Returns
-------
An instance of QueryExecution or None when the value is not set yet.
An instance of ExecutionInfo or None when the value is not set yet.
Notes
-----
Expand Down
2 changes: 1 addition & 1 deletion python/pyspark/sql/metrics.py
Original file line number Diff line number Diff line change
Expand Up @@ -269,7 +269,7 @@ def toDot(self, filename: Optional[str] = None, out_format: str = "png") -> "gra


class ExecutionInfo:
"""The query execution class allows users to inspect the query execution of this particular
"""The ExecutionInfo class allows users to inspect the query execution of this particular
data frame. This value is only set in the data frame if it was executed."""

def __init__(
Expand Down

0 comments on commit 99b7939

Please sign in to comment.