Blosc/python-blosc2

[DOC] Glossary page for core concepts

Open

#651 opened on Jun 2, 2026

View on 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)

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.

Contributor guide

Research direction
Review the existing API documentation to understand each term (SChunk, frame, chunk, block, subblock, etc.) and compile definitions with links to relevant API reference pages.
Tech stack
python
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
PythonreStructuredTextGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85