Docs Request: "Features" page about the `dy.Collection` type
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 618
- Forks
- 21
- Avg merge
- 14h 34m
- Merged PRs (30d)
- 7
Description
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:
- How do you define foreign key relationships in a
dy.Collectiondata model? Is it done automatically by column name? Is there a way to do it manually? - How do you specify the cardinality of join validations (e.g., 1:1, 1:m, etc.).
- 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).
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the existing Features section, the Real-world Example, and the generated API documentation for dy.Collection. Review the Collection behavior behind foreign-key relationships, join cardinality, and null handling, then document common workflows and clearly answer those questions in the new page.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100