Conversation
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
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?
Closes #1726
Rationale for this change
With recent PRs (such as #1723) modifying the examples to encode durable metadata, the "Encode metadata, not a handle to a live object" section in the extension guide needed a structural rewrite to reflect the current state of the codebase. It now correctly leads with positive examples and clarifies that the token registry used in the
ForeignExecutionPlanarm is a marked workaround, not a pattern to emulate.What changes are included in this PR?
docs/source/extension-guide/codecs.md: Rewrites the section to point todatafusion-ffi-example(logical codec) andexamples/distributed/storage-libraryas the primary, positive examples of encoding durable metadata.docs/source/extension-guide/codecs.md: Explains that a token registry is a consequence of an upstream defect ([Umbrella] FFI planner boundary: foreign-wrapped nodes, lost plan properties, and severed dynamic filters datafusion#25152) and isolates it to theForeignExecutionPlanarm. Adds a bidirectional link toextension_codec_order.docs/source/extension-guide/checklist.md: Updates the checklist to clarify that the token workaround is now limited to "one arm of one codec" rather than a general practice in the repository's examples.Are there any user-facing changes?
No (documentation improvements only).