peter-toth opened a new pull request, #364:
URL: https://github.com/apache/spark-connect-swift/pull/364
### What changes were proposed in this pull request?
This PR fixes typos, awkward wording, and incorrect API usage in code
samples across the project documentation:
- `README.md`: `## Requirement` -> `## Requirements`.
- `Examples/spark-sql/README.md` and
`Sources/SparkConnect/Documentation.docc/Examples.md`: fix
`REPL(Read-eval-print Loop)` spacing/capitalization to `REPL (Read-Eval-Print
Loop)`.
- `Sources/SparkConnect/Documentation.docc/Examples.md`: reword the Netcat
output sentence in the streaming section.
- `Examples/stream/README.md`: minor wording fix ("printed on screen" ->
"printed to the screen").
- `Sources/SparkConnect/Documentation.docc/GettingStarted.md`:
- `from: "main"` is invalid for SwiftPM (`from:` requires a `Version`);
change to `branch: "main"` to match the root README.
- Drop incorrect `await` on `selectExpr`, which is not `async`.
- Add missing `try await` to `result.show()`.
- `Sources/SparkConnect/Documentation.docc/SparkSession.md`: add missing
`try await` to `spark.range(...)` and `spark.sql(...)`, both of which are
`async throws`.
### Why are the changes needed?
Documentation should be accurate. The code snippets in `GettingStarted.md`
and `SparkSession.md` will not compile as written, which is misleading for new
users following the docs. The other items are typos and wording polish.
### Does this PR introduce _any_ user-facing change?
No. Documentation-only changes.
### How was this patch tested?
Manually reviewed the diffs and cross-checked the documented APIs against
their definitions in `SparkSession.swift`, `DataFrame+Actions.swift`, and
`DataFrame+Transformations.swift` to confirm the corrected `async`/`throws`
annotations.
### Was this patch authored or co-authored using generative AI tooling?
Generated-by: Claude Opus 4.7
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
