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

Offen Anfängerfreundlich
#1,726 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
2/5
Geschätzter Aufwand
1-3 Stunden
Anfängerfreundlichkeit
72/100
Issue-Typ
Dokumentation
Klarheit
Größtenteils klar
Aktivitätsstatus
Aktiv
Tech-Stack
markdown
Bereich
documentation

Rechercherichtung

Beginne damit, extension-guide/codecs.md im Abschnitt, der überarbeitet wird, zu lesen, und prüfe anschließend die beiden blockierenden Sub-Issues sowie extension-guide/checklist.md:109, um die daraus resultierenden Fakten zu bestätigen. Verschiebe datafusion-ffi-example in die positiven Beispiele, erläutere die Konsequenz für die Registry und benenne den verbleibenden ForeignExecutionPlan-Workaround zusammen mit seinem Upstream-Issue und der Bedingung für seine Löschung; aktualisiere die Formulierung der Checkliste entsprechend.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

documentation

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.

Vorherrschende Sprache
Python
Sterne
605
Forks
176
Ø Merge
1 T. 23 Std.
Gemergte PRs (30 T.)
8

Beitragsleitfaden

Für dieses Repository ist kein Beitragsleitfaden indexiert

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus apache/datafusion-python

Alle Issues in apache/datafusion-python

Ähnliche Issues

Weitere Issues zu Python

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.