This is an automated email from the ASF dual-hosted git repository.
dongjoon pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/spark-connect-swift.git
The following commit(s) were added to refs/heads/main by this push:
new 230b82a [MINOR] Revise SparkSession documentation
230b82a is described below
commit 230b82ab261842547bf6ba260cfcdc2fadfc267a
Author: Dongjoon Hyun <[email protected]>
AuthorDate: Sun May 18 19:17:09 2025 -0700
[MINOR] Revise SparkSession documentation
### What changes were proposed in this pull request?
This PR aims to revise `SparkSession` documentation by fixing typos and
inconsistency.
### Why are the changes needed?
To provider a better document.
### Does this PR introduce _any_ user-facing change?
No behavior change.
### How was this patch tested?
Manual review.
### Was this patch authored or co-authored using generative AI tooling?
No.
Closes #162 from dongjoon-hyun/minor_doc.
Authored-by: Dongjoon Hyun <[email protected]>
Signed-off-by: Dongjoon Hyun <[email protected]>
---
Sources/SparkConnect/Documentation.docc/GettingStarted.md | 5 +++--
Sources/SparkConnect/Documentation.docc/SparkSession.md | 7 ++++---
2 files changed, 7 insertions(+), 5 deletions(-)
diff --git a/Sources/SparkConnect/Documentation.docc/GettingStarted.md
b/Sources/SparkConnect/Documentation.docc/GettingStarted.md
index 9aed405..1486b51 100644
--- a/Sources/SparkConnect/Documentation.docc/GettingStarted.md
+++ b/Sources/SparkConnect/Documentation.docc/GettingStarted.md
@@ -36,10 +36,11 @@ targets: [
```swift
import SparkConnect
-let spark = SparkSession.builder()
+let spark = try await SparkSession
+ .builder
.appName("MySwiftApp")
.remote("sc://localhost:15002")
- .build()
+ .getOrCreate()
```
### 2. DataFrame Operations
diff --git a/Sources/SparkConnect/Documentation.docc/SparkSession.md
b/Sources/SparkConnect/Documentation.docc/SparkSession.md
index 2fa4425..2575b73 100644
--- a/Sources/SparkConnect/Documentation.docc/SparkSession.md
+++ b/Sources/SparkConnect/Documentation.docc/SparkSession.md
@@ -9,10 +9,11 @@ The entry point for SparkConnect functionality.
### Creating a SparkSession
```swift
-let spark = SparkSession.builder()
- .appName("My Swift Spark App")
+let spark = try await SparkSession
+ .builder
+ .appName("MySwiftApp")
.remote("sc://localhost:15002")
- .build()
+ .getOrCreate()
```
### Basic Usage
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
