[DOC] Glossary page for core concepts
- 主要言語
- Python
- スター
- 211
- フォーク
- 58
- 平均マージ
- 1日 17時間
- マージ済み PR(30日)
- 6
説明
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.
コントリビューションガイド
調査の方向性
doc/getting_started/index.rst と関連する API リファレンスページから始めて、リンクと用語を確認します。列挙されたコア概念、圧縮パラメータ、コンテナの選択肢、インデックスタイプを扱う doc/getting_started/glossary.rst を作成し、getting-started インデックスからリンクします。すべての要求された用語に簡潔な定義と API リファレンスへのリンクがあれば、用語集は完成です。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- python
- 領域
- documentation
- issue の種類
- ドキュメント
- 難易度
- 2/5
- 見積もり時間
- 半日
- 活発さ
- 静か
- 明瞭さ
- 明確に書かれている
- 初心者へのやさしさ
- 74/100