[DOC] Glossary page for core concepts
- Vorherrschende Sprache
- Python
- Sterne
- 211
- Forks
- 58
- Ø Merge
- 1 T. 17 Std.
- Gemergte PRs (30 T.)
- 6
Beschreibung
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.
Beitragsleitfaden
Rechercherichtung
Beginnen Sie mit doc/getting_started/index.rst und den relevanten API-Referenzseiten, um Links und Terminologie zu identifizieren. Erstellen Sie doc/getting_started/glossary.rst, das die aufgeführten Kernkonzepte, Komprimierungsparameter, Container-Auswahlmöglichkeiten und Indextypen abdeckt, und verlinken Sie es vom Getting-Started-Index; das Glossar ist fertig, wenn jeder angeforderte Begriff eine prägnante Definition und einen API-Referenzlink enthält.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- python
- Bereich
- documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 2/5
- Geschätzter Aufwand
- Ein halber Tag
- Aktivitätsstatus
- Ruhig
- Klarheit
- Klar beschrieben
- Anfängerfreundlichkeit
- 74/100