Blosc/python-blosc2

[DOC] Glossary page for core concepts

Open

#651 aperta il 2 giu 2026

Vedi su GitHub
 (0 commenti) (0 reazioni) (0 assegnatari)Python (47 fork)auto 404
documentationgood first issue

Metriche repository

Star
 (207 star)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

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.

Guida contributor

Direzione di ricerca
Esamina la documentazione API esistente per comprendere ciascun termine (SChunk, frame, chunk, block, subblock, ecc.) e compila le definizioni con collegamenti alle relative pagine di riferimento API.
Tech stack
python
Dominio
documentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
PythonreStructuredTextGit
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
85