apache / apache/datafusion-python

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

オープン 初心者向け
#1,726 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る
documentation
主要言語
Python
スター
604
フォーク
174
平均マージ
1日 7時間
マージ済み PR(30日)
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.

コントリビューションガイド

このリポジトリのコントリビューションガイドは索引されていません

調査の方向性

Start by reading extension-guide/codecs.md around the section being rewritten, then review the two blocking sub-issues and extension-guide/checklist.md:109 to confirm the resulting facts. Move datafusion-ffi-example into the positive examples, explain the registry consequence, and identify the remaining ForeignExecutionPlan workaround with its upstream issue and deletion condition; update the checklist wording accordingly.

索引モデルが issue の本文から書いたものです。

評価

技術スタック
markdown
領域
documentation
issue の種類
ドキュメント
難易度
2/5
見積もり時間
1〜3時間
活発さ
活発
明瞭さ
おおむね明確
初心者へのやさしさ
72/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。