HyukjinKwon commented on PR #53:
URL:
https://github.com/apache/spark-connect-rust/pull/53#issuecomment-5417400317
Thanks @viirya — reviewing after merge is appreciated, and both compile
errors plus the CI gap are addressed in #54 (which is rebased onto master, so
these land on top of the merged docs):
- **`docs/quickstart.md`** — `lit` is now imported: `use
spark_connect::{functions as f, lit};`.
- **`docs/configuration.md`** — both remote-connection examples now `use
spark_connect::SparkSessionBuilder;`.
- (Also found and fixed the same class in `docs/types.md`: the cast example
used `col` without importing it.)
**The CI gap** — the docs workflow only deployed, so nothing checked the
snippets. #54 adds a PR-time `validate` job (runs on forks/branches, no deploy)
that does `mkdocs build --strict` for nav/link/config regressions **and**
compiles every ```rust``` block against the crate via
`scripts/check_doc_snippets.py` (rustc, no execution/server needed). It checks
51 snippets green today and would have caught all three errors above (it
flagged the `col` one before I fixed it). Feature-gated/continuation examples
(the wasm-udf page, a streaming `query.stop()` fragment) are fenced
```rust,ignore``` per the usual convention. Going the full "real files under
`examples/` via `pymdownx.snippets`" route is a reasonable follow-up.
--
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]