Rewrite the "Encode metadata, not a handle to a live object" section
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 72/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Active
- Tech stack
- markdown
- Domain
- documentation
Research direction
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.
Written by the indexing model from the issue text.
Description
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
ForeignExecutionPlanarm, 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, alongsideexamples/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.
- Dominant language
- Python
- Stars
- 605
- Forks
- 176
- Avg merge
- 1d 23h
- Merged PRs (30d)
- 8
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from apache/datafusion-python
-
Difficulty 2/5 Half a day Newbie friendliness 88/100
apache/datafusion-python#1691 ·
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
apache/datafusion-python#1644 ·
-
enhancement
Difficulty 5/5 Over a week Newbie friendliness 30/100
apache/datafusion-python#1737 ·
-
Difficulty 3/5 1-2 days Newbie friendliness 76/100
apache/datafusion-python#1735 · 1 comment ·
-
bug good first issue
Difficulty 4/5 3-5 days Newbie friendliness 48/100
apache/datafusion-python#1728 ·
All issues in apache/datafusion-python
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100