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

   ## Which issue does this PR close?
   
   Part of #56: the "Build the docs with `RUSTDOCFLAGS="-D warnings"`" item.
   
   ## Rationale for this change
   
   Nothing in CI builds the API docs. A broken intra-doc link, invalid HTML in 
a doc comment or another rustdoc warning only shows up on docs.rs after a 
release. apache/datafusion checks this in `ci/scripts/rust_docs.sh`, and 
nothing replaced that check when the crate moved here.
   
   ## What changes are included in this PR?
   
   A new `.github/workflows/docs.yml` that runs `cargo doc 
--document-private-items --no-deps --workspace --all-features` with 
`RUSTDOCFLAGS: -D warnings`.
   
   - The flags are the same as DataFusion's, plus `--all-features`. That flag 
documents the items behind the `core` feature, as docs.rs does 
(`[package.metadata.docs.rs] all-features = true`).
   - It is a separate workflow file, so it doesn't conflict with #318, which 
adds `test.yml`, or #320, which adds a job to `lint.yml`.
   
   ## Are these changes tested?
   
   The command passes locally on current `main` and on the branch of #57, which 
improves the crate's API docs. So this check won't block #57. This PR can be 
rebased after #57 merges. `actionlint` reports no problems, and the workflow 
runs on this PR.
   
   ## Are there any user-facing changes?
   
   No.
   
   _This PR was written by an LLM (Claude) and reviewed before opening._
   
   🤖 Generated with [Claude Code](https://claude.com/claude-code)
   


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