[DOC] Glossary page for core concepts
- Langage dominant
- Python
- Étoiles
- 211
- Forks
- 58
- Merge moyen
- 1 j 17 h
- PR mergées (30 j)
- 6
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 de contribution
Ouvrir le guide de contribution
Piste de recherche
Commencez par doc/getting_started/index.rst et les pages de référence API pertinentes afin d’identifier les liens et la terminologie. Créez doc/getting_started/glossary.rst couvrant les concepts fondamentaux, les paramètres de compression, les choix de conteneurs et les types d’index indiqués, puis ajoutez-y un lien depuis l’index de démarrage ; le glossaire est terminé lorsque chaque terme demandé dispose d’une définition concise et d’un lien vers la référence API.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- python
- Domaine
- documentation
- Type d'issue
- Documentation
- Difficulté
- 2/5
- Temps estimé
- Une demi-journée
- Activité
- Calme
- Clarté
- Clairement spécifiée
- Accessibilité débutants
- 74/100