andygrove opened a new pull request, #57:
URL: https://github.com/apache/datafusion-spark/pull/57

   Part of #55
   
   ## Rationale
   
   The published crate page on crates.io is generic, and docs.rs shows a bare 
list of function modules with no descriptions.
   
   ## Changes
   
   - Rewrite `crates/spark/README.md` (shown on crates.io) as a user-facing 
landing page: what the crate is and why, quick start, caveats, contributing. 
Fix the broken SQLLogicTest README link.
   - Expand the crate-level docs in `lib.rs` (motivation, getting started, 
packages, semantics and caveats).
   - Add `//!` module docs to every function package. Packages with no 
functions yet say so.
   - Document `SparkFunctionPlanner`.
   - Add `keywords`, `categories` and `documentation` to `Cargo.toml`.
   
   ## Testing
   
   Docs only. I could not run `cargo doc` in my checkout (no workspace root), 
so please check that CI's doc build is clean. The README quick-start snippet 
mirrors the existing `SessionStateBuilderSpark` doctest.
   
   Per-function documentation is tracked separately in #55.


-- 
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]

Reply via email to