Blosc/python-blosc2

[DOC] Glossary page for core concepts

Open

#651 opened on 2026年6月2日

GitHub で見る
 (0 comments) (0 reactions) (0 assignees)Python (47 forks)auto 404
documentationgood first issue

Repository metrics

Stars
 (207 stars)
PR merge metrics
 (PR metrics pending)

説明

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.

コントリビューターガイド