docs: update proto-models README for the datafusion-common dependency - #67
Closed
adriangb wants to merge 1 commit into
Closed
docs: update proto-models README for the datafusion-common dependency#67adriangb wants to merge 1 commit into
adriangb wants to merge 1 commit into
Conversation
`datafusion-proto-models` now depends on `datafusion-common` and hosts the `From` / `TryFrom` conversions between the generated proto types and their `datafusion-common` counterparts, but the crate README still claimed it had no DataFusion dependencies beyond `datafusion-proto-common` and exposed only the generated structs. Describe the conversions and why they live in this crate, and spell out the narrowness that still holds: `datafusion-common` and `datafusion-proto-common` are the only DataFusion dependencies. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01GoAdfGfHwhLreDPDQ9GoDK
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Which issue does this PR close?
Follow-up to the review comment on apache#24205: apache#24205 (comment)
No separate issue.
Rationale for this change
apache#24205 ("Restore the
From/TryFromproto conversions dropped since 54.1.0") adds a directdatafusion-commondependency todatafusion-proto-modelsand puts theFrom/TryFromimpls in the crate.datafusion/proto-models/README.mdwas not updated alongside it, so it now says the opposite of what is true:@timsaucer flagged this on the Cargo.toml change; the reply there was that it would be handled as a follow-up. That's this PR.
The crate's
lib.rsdocs were already updated in apache#24205 — this brings the README in line with them.What changes are included in this PR?
datafusion/proto-models/README.mdonly:From/TryFromconversions between the generated proto types and thedatafusion-commontypes they mirror, with the reason those impls live here (the DataFusion side sits below this crate in the dependency graph, mirroring howdatafusion-proto-commonhandlesScalarValueandStatistics).datafusion-commonanddatafusion-proto-commonare the only DataFusion dependencies, and nodatafusion-expror execution crates.datafusion-commoncrates.io link definition.Note: this is written against the post-apache#24205 state of the crate, so it should be reviewed/merged after apache#24205 lands. It's based on
mainrather than stacked on that branch, so it does not depend on it mechanically and will not conflict.Are these changes tested?
Not applicable — documentation only.
./ci/scripts/doc_prettier_check.shpasses (it made no changes to the file).Are there any user-facing changes?
Documentation only; no API or behavior changes. The corrected text is user-facing in the sense that this README is the crate's rendered description on crates.io.
Generated by Claude Code