Awesome06 opened a new pull request, #1785:
URL: https://github.com/apache/datafusion-python/pull/1785
# Which issue does this PR close?
<!--
We generally require a GitHub issue to be filed for all bug fixes and
enhancements and this helps us generate change logs for our releases. You can
link an issue to this PR using the GitHub syntax. For example `Closes #123`
indicates that this PR will close issue #123.
-->
Closes #1726
# Rationale for this change
<!--
Why are you proposing this change? If this is already explained clearly in
the issue then this section is not needed.
Explaining clearly why changes are proposed helps reviewers understand your
changes and offer better suggestions for fixes.
-->
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 `ForeignExecutionPlan` arm is a marked workaround,
not a pattern to emulate.
# What changes are included in this PR?
<!--
There is no need to duplicate the description in the issue here but it is
sometimes worth providing a summary of the individual changes in this PR.
-->
* **`docs/source/extension-guide/codecs.md`**: Rewrites the section to point
to `datafusion-ffi-example` (logical codec) and
`examples/distributed/storage-library` as 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 (apache/datafusion#25152) and
isolates it to the `ForeignExecutionPlan` arm. Adds a bidirectional link to
`extension_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?
<!--
If there are user-facing changes then we may require documentation to be
updated before approving the PR.
-->
No (documentation improvements only).
--
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]
