apache / apache/datafusion-python

Rewrite the "Encode metadata, not a handle to a live object" section

未關閉 適合新手
#1,726 0 則留言 0 個 reaction 已指派 0 人 在 GitHub 檢視
documentation
主要語言
Python
星號
604
分支
174
平均合併
1 天 7 小時
30 天內合併 PR
4

描述

Blocked on the two sub-issues above — this describes the state they produce.

#1721 corrected the factually wrong attribution in `extension-guide/codecs.md` (it named `datafusion-ffi-query-planner-example`, which has no registry) and connected the broad claim at line 185 to the registry it forces. That was deliberately minimal, because the underlying facts were about to change.

Once the logical codec encodes durable metadata and the greedy arm is quarantined, the section should be rewritten rather than patched again:

- **Lead with the positive example.** Two paragraphs of what-not-to-do before the reader sees a correct codec is the wrong order.
- **State the registry as a consequence, not a choice.** A codec that downcasts to its own concrete types is never handed something it cannot describe. The cause is already explained under `extension_codec_order`, 100 lines further down; the two should link to each other.
- **Name the one remaining offender precisely** — the `ForeignExecutionPlan` arm, with the upstream issue and the delete-when condition, so a reader can tell a marked workaround from sloppiness.
- `datafusion-ffi-example`'s logical codec moves from the counter-example list to the example list, alongside `examples/distributed/storage-library`.

Also check `extension-guide/checklist.md:109`, which says "the examples in this repository use tokens to make ownership observable" — that becomes true of one arm of one codec rather than of the examples generally.

貢獻指南

這個儲存庫沒有索引到貢獻指南

研究方向

先閱讀待重寫部分附近的 extension-guide/codecs.md,接著檢視兩個阻塞性子 issue 和 extension-guide/checklist.md:109,以確認由此得到的事實。將 datafusion-ffi-example 移至正面範例中,說明對 registry 的影響,並指出剩餘的 ForeignExecutionPlan workaround、其 upstream issue 以及刪除條件;相應地更新 checklist 的措辭。

由索引模型根據 Issue 內容生成。

評估

技術堆疊
markdown
領域
documentation
Issue 類型
文件
難度
2/5
預估耗時
1-3 小時
活躍度
活躍
描述清晰度
基本清楚
新手友好度
72/100

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。