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

Aperta Adatta ai principianti
#1,726 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
72/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Attiva
Stack tecnologico
markdown
Ambito
documentation

Direzione di ricerca

Inizia leggendo extension-guide/codecs.md intorno alla sezione in fase di riscrittura, poi esamina le due sub-issue bloccanti e extension-guide/checklist.md:109 per confermare i fatti risultanti. Sposta datafusion-ffi-example negli esempi positivi, spiega la conseguenza per il registry e identifica il workaround rimanente di ForeignExecutionPlan con la relativa issue upstream e la condizione per la sua eliminazione; aggiorna di conseguenza il testo della checklist.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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.

Lingua principale
Python
Stelle
605
Fork
176
Merge medio
1g 23h
PR unite (30g)
8

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di apache/datafusion-python

Tutte le issue di apache/datafusion-python

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.