Blosc/python-blosc2

[DOC] Glossary page for core concepts

Open

#651 aberto em 2 de jun. de 2026

Ver no GitHub
 (0 comments) (0 reactions) (0 assignees)Python (47 forks)auto 404
documentationgood first issue

Métricas do repositório

Stars
 (207 stars)
Métricas de merge de PR
 (Métricas PR pendentes)

Description

New contributors and users frequently confuse chunks, blocks, frames, and superchunks — terms that appear throughout the API but are never defined in one place. The getting-started section has no glossary.

Suggested work: Create doc/getting_started/glossary.rst (and link it from doc/getting_started/index.rst) defining at minimum:

  • SChunk, frame, chunk, block, subblock
  • Compression parameters (cparams): codec, clevel, filters
  • NDArray vs CTable vs SChunk — when to use each
  • Index types: SUMMARY, BUCKET, PARTIAL, FULL, OPSI — one-sentence each

Each term should link to the relevant API reference page.

Guia do colaborador

Direção de pesquisa
Revise a documentação existente da API para entender cada termo (SChunk, frame, chunk, block, subblock, etc.) e compile definições com links para as respectivas páginas de referência da API.
Pilha de tecnologia
python
Domain
documentation
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
PythonreStructuredTextGit
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
85