Blosc / Blosc/python-blosc2

[DOC] Glossary page for core concepts

Abierto Apto para principiantes
#651 0 comentarios 0 reacciones 0 asignados Ver en GitHub
documentation good first issue
Lenguaje dominante
Python
Estrellas
211
Forks
58
Merge medio
1 d 17 h
PR fusionados (30 d)
6

Descripción

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.

Guía de contribución

Abrir la guía de contribución

Línea de trabajo

Comience con doc/getting_started/index.rst y las páginas de referencia de API pertinentes para identificar enlaces y terminología. Cree doc/getting_started/glossary.rst que cubra los conceptos básicos, los parámetros de compresión, las opciones de contenedor y los tipos de índice indicados, y enlácelo desde el índice de introducción; el glosario estará terminado cuando cada término solicitado tenga una definición concisa y un enlace a la referencia de API.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
python
Área
documentation
Tipo de issue
Documentación
Dificultad
2/5
Tiempo estimado
Medio día
Estado de actividad
Tranquilo
Claridad
Bien especificado
Aptitud para principiantes
74/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.