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

Aberta Para iniciantes
#1,726 0 comentários 0 reações 0 responsáveis Ver no GitHub

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
2/5
Tempo estimado
1-3 horas
Facilidade para iniciantes
72/100
Tipo de issue
Documentação
Clareza
Razoavelmente clara
Status de atividade
Ativa
Stack de tecnologia
markdown
Domínio
documentation

Direção de pesquisa

Comece lendo extension-guide/codecs.md ao redor da seção que está sendo reescrita e, em seguida, revise as duas sub-issues bloqueadoras e extension-guide/checklist.md:109 para confirmar os fatos resultantes. Mova datafusion-ffi-example para os exemplos positivos, explique a consequência para o registry e identifique o workaround restante de ForeignExecutionPlan com sua issue upstream e a condição para sua remoção; atualize a redação da checklist de acordo.

Escrita pelo modelo de indexação a partir do texto da issue.

Descrição

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.

Linguagem predominante
Python
Estrelas
605
Forks
176
Merge médio
1d 23h
PRs com merge (30d)
8

Guia de contribuição

Nenhum guia de contribuição indexado para este repositório

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de apache/datafusion-python

Todas as issues de apache/datafusion-python

Issues semelhantes

Mais issues de Python

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.