Blosc/python-blosc2

[DOC] Glossary page for core concepts

Open

#651 建立於 2026年6月2日

在 GitHub 查看
 (0 留言) (0 反應) (0 負責人)Python (47 fork)auto 404
documentationgood first issue

倉庫指標

Star
 (207 star)
PR 合併指標
 (PR 指標待抓取)

描述

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.

貢獻者指南