[DOC] Glossary page for core concepts
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- Half a day
- Newbie friendliness
- 74/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Quiet
- Tech stack
- python
- Domain
- documentation
Research direction
Start with doc/getting_started/index.rst and the relevant API reference pages to identify links and terminology. Create doc/getting_started/glossary.rst covering the listed core concepts, compression parameters, container choices, and index types, then link it from the getting-started index; the glossary is done when every requested term has a concise definition and API reference link.
Written by the indexing model from the issue text.
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.
- Dominant language
- Python
- Stars
- 211
- Forks
- 63
- Avg merge
- 1d 7h
- Merged PRs (30d)
- 5
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from Blosc/python-blosc2
-
documentation sustain-2026
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
Blosc/python-blosc2#710 ·
-
documentation good first issue sustain-2026
Difficulty 2/5 Half a day Newbie friendliness 74/100
Blosc/python-blosc2#650 ·
-
Difficulty 5/5 Over a week Newbie friendliness 35/100
Blosc/python-blosc2#693 ·
-
Difficulty 5/5 Over a week Newbie friendliness 35/100
Blosc/python-blosc2#689 ·
-
Difficulty 4/5 3-5 days Newbie friendliness 48/100
Blosc/python-blosc2#664 · 1 comment ·
All issues in Blosc/python-blosc2
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100