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

Clarify benefits of factory methods in Module 2

Abierto
#31 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
2/5
Tiempo estimado
Medio día
Aptitud para principiantes
55/100
Tipo de issue
Documentación
Claridad
Bien especificado
Estado de actividad
Estancado
Stack tecnológico
jupyter-notebook, python
Área
documentation

Línea de trabajo

Comienza con la sección de métodos estáticos en Module 2 y revisa su explicación actual de los factory methods. Añade la terminología y la justificación solicitadas, así como ejemplos de datetime y polars; se considera terminado cuando la sección explique cuándo y por qué usar el patrón e incluya los ejemplos indicados.

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

Descripción

The static methods section in Module 2 shows how to create factory methods but could better explain when and why to use them.

Current state

The notes mention it's "less cumbersome" to create instances, but the pedagogical value could be stronger.

Suggested improvements

  1. Name the pattern - Use the term "factory method" or "alternative constructor" so students can recognize and search for it

  2. Explain the "why" - Python doesn't support multiple __init__ signatures, so factory methods provide multiple construction paths with semantic clarity

  3. Add stdlib examples from datetime:

    • datetime.fromtimestamp()
    • datetime.fromisoformat()
    • date.fromordinal()

  4. Add examples from polars:

    • pl.read_csv(), pl.read_parquet(), pl.read_json() (module-level factories)
    • DataFrame.to_dict() → pl.from_dict() round-trip
    • pl.from_numpy(), pl.from_pandas()

These examples show the pattern is pervasive in well-designed Python APIs.

Lenguaje dominante
Jupyter Notebook
Estrellas
8
Forks
1
Merge medio
4 min
PR fusionados (30 d)
1

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 DHI/python-package-development

Todos los issues de DHI/python-package-development

Issues similares

Más issues de Documentation

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.