Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

Docs Request: "Features" page about the `dy.Collection` type

Đang mở
#162 3 bình luận 2 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Đánh giá

Độ khó
3/5
Thời gian dự kiến
1-2 ngày
Mức phù hợp với người mới
48/100
Loại issue
Tài liệu
Độ rõ ràng
Khá 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 phần Features hiện có, Real-world Example và tài liệu API được tạo cho dy.Collection. Xem xét hành vi của Collection đối với các mối quan hệ khóa ngoại, lực lượng bản số của phép join và cách xử lý null, sau đó dokument các workflow phổ biến và trả lời rõ ràng những câu hỏi đó trong trang mới.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

Now that there's a "Features" section in the docs, it might be helpful to cover the dy.Collection class in there, with a focus more on "what are some common workflows" (as opposed to the existing example in "Real-world Example", and the noisy API documentation generated for that class).

Some question to think about that might be relevant:

  1. How do you define foreign key relationships in a dy.Collection data model? Is it done automatically by column name? Is there a way to do it manually?
  2. How do you specify the cardinality of join validations (e.g., 1:1, 1:m, etc.).
  3. How do you specify whether nulls are treated as a "value" in the join, vs. the absense of data? SQL always takes the former approach, but Polars is nice in that it lets you select whether null is a value itself or a marker for missing/unknown data (e.g., by its nulls_equal= argument).
Ngôn ngữ chính
Python
Star
618
Fork
21
Merge trung bình
14 giờ 34 phút
Pull request đã merge (30 ngày)
7

Hướng dẫn đóng góp

Chưa lập chỉ mục được hướng dẫn đóng góp cho kho mã nguồn này

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. 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.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của Quantco/dataframely

Tất cả issue của Quantco/dataframely

Issue tương tự

Thêm issue về Python

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.