[DOC] Glossary page for core concepts
Chưa có ai nhận issue này.
Đánh giá
- Độ khó
- 2/5
- Thời gian dự kiến
- Nửa ngày
- Mức phù hợp với người mới
- 74/100
- Loại issue
- Tài liệu
- Độ rõ ràng
- Đặc tả rõ ràng
- Mức độ hoạt động
- Ít trao đổi
- Công nghệ
- python
- Lĩnh vực
- documentation
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.
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.
- Ngôn ngữ chính
- Python
- Star
- 211
- Fork
- 63
- Merge trung bình
- 1 ngày 7 giờ
- Pull request đã merge (30 ngày)
- 5
Hướng dẫn đóng góp
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Issue khác của Blosc/python-blosc2
-
Improve the remote array guide Đang mởdocumentation sustain-2026
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 76/100
Blosc/python-blosc2#710 ·
-
documentation good first issue sustain-2026
Độ khó 2/5 Nửa ngày Mức phù hợp với người mới 74/100
Blosc/python-blosc2#650 ·
-
Độ khó 5/5 Hơn một tuần Mức phù hợp với người mới 35/100
Blosc/python-blosc2#693 ·
-
Độ khó 5/5 Hơn một tuần Mức phù hợp với người mới 35/100
Blosc/python-blosc2#689 ·
-
Độ khó 4/5 3-5 ngày Mức phù hợp với người mới 48/100
Blosc/python-blosc2#664 · 1 bình luận ·
Tất cả issue của Blosc/python-blosc2
Issue tương tự
-
documentation help wanted
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 90/100
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 90/100
simonw/sqlite-utils#872 ·
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 88/100
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 82/100
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 78/100