Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

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

Abierto
#162 3 comentarios 2 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
3/5
Tiempo estimado
1-2 días
Aptitud para principiantes
48/100
Tipo de issue
Documentación
Claridad
Bastante claro
Estado de actividad
Tranquilo
Stack tecnológico
python
Área
documentation

Línea de trabajo

Comienza con la sección existente Features, el Real-world Example y la documentación de API generada para dy.Collection. Revisa el comportamiento de Collection en relación con las relaciones de claves foráneas, la cardinalidad de los joins y el manejo de null; después, documenta los flujos de trabajo habituales y responde claramente a esas preguntas en la nueva página.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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).
Lenguaje dominante
Python
Estrellas
618
Forks
21
Merge medio
14 h 34 min
PR fusionados (30 d)
7

Guía de contribución

No hay ninguna guía de contribución indexada para este repositorio

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de Quantco/dataframely

Todos los issues de Quantco/dataframely

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.