Blosc/python-blosc2

[DOC] Glossary page for core concepts

Open

#651 ouverte le 2 juin 2026

Voir sur GitHub
 (0 commentaires) (0 réactions) (0 assignés)Python (47 forks)auto 404
documentationgood first issue

Métriques du dépôt

Stars
 (207 stars)
Métriques de merge PR
 (Métriques PR en attente)

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.

Guide contributeur

Direction de recherche
Consultez la documentation existante de l'API pour comprendre chaque terme (SChunk, frame, chunk, block, subblock, etc.) et compilez des définitions avec des liens vers les pages de référence de l'API correspondantes.
Stack technique
python
Domaine
documentation
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
PythonreStructuredTextGit
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
85