Blosc / Blosc/python-blosc2

[DOC] Glossary page for core concepts

Aperta Adatta ai principianti
#651 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub
documentation good first issue
Lingua principale
Python
Stelle
211
Fork
58
Merge medio
1g 17h
PR unite (30g)
6

Descrizione

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.

Guida per i contributori

Apri la guida per i contributori

Direzione di ricerca

Iniziare da doc/getting_started/index.rst e dalle pagine pertinenti della documentazione di riferimento API per identificare i link e la terminologia. Creare doc/getting_started/glossary.rst, che copra i concetti fondamentali elencati, i parametri di compressione, le scelte dei contenitori e i tipi di indice, quindi collegarlo dall’indice introduttivo; il glossario è completo quando ogni termine richiesto ha una definizione concisa e un link alla documentazione di riferimento API.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
python
Ambito
documentation
Tipo di issue
Documentazione
Difficoltà
2/5
Tempo stimato
Mezza giornata
Stato di attività
Tranquilla
Chiarezza
Specificata chiaramente
Idoneità per principianti
74/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.