[DOC] Glossary page for core concepts
- Ngôn ngữ chính
- Python
- Star
- 211
- Fork
- 58
- Merge trung bình
- 1 ngày 17 giờ
- Pull request đã merge (30 ngày)
- 6
Mô tả
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.
Hướng dẫn đóng góp
Hướng nghiên cứu
Bắt đầu với doc/getting_started/index.rst và các trang tham chiếu API liên quan để xác định các liên kết và thuật ngữ. Tạo doc/getting_started/glossary.rst bao quát các khái niệm cốt lõi được liệt kê, các tham số nén, các lựa chọn container và các loại chỉ mục, sau đó liên kết đến tệp này từ chỉ mục getting-started; glossary hoàn tất khi mọi thuật ngữ được yêu cầu đều có một định nghĩa ngắn gọn và liên kết tham chiếu API.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Đánh giá
- Công nghệ
- python
- Lĩnh vực
- documentation
- Loại issue
- Tài liệu
- Độ khó
- 2/5
- Thời gian dự kiến
- Nửa ngày
- Mức độ hoạt động
- Ít trao đổi
- Độ rõ ràng
- Đặc tả rõ ràng
- Mức phù hợp với người mới
- 74/100