Missing docstring examples in the `unparser` module

Abierto Apto para principiantes
#1,691 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
88/100
Tipo de issue
Documentación
Claridad
Bien especificado
Estado de actividad
Activo
Stack tecnológico
python
Área
documentation

Línea de trabajo

Comienza en python/datafusion/unparser.py y lee los docstrings existentes de Dialect y Unparser; después, inspecciona la prueba actual del unparser para SELECT 1 para conocer la configuración. Añade ejemplos con estilo doctest que muestren las diferencias entre dialectos, aclara los resúmenes de Dialect y with_pretty y ejecuta pytest con --doctest-modules. La tarea estará terminada cuando todas las funciones públicas enumeradas tengan ejemplos de uso que pasen y se haya corregido la redacción.

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

Descripción

Description

AGENTS.md requires every public Python function to carry a usage example, but
none of the public functions in python/datafusion/unparser.py have one:

  • Dialect.default
  • Dialect.mysql
  • Dialect.postgres
  • Dialect.sqlite
  • Dialect.duckdb
  • Unparser.plan_to_sql
  • Unparser.with_pretty

The gap matters more here than in most modules, because the reason Dialect
exists is that different dialects render the same plan differently, and nothing
in the current documentation shows that difference. The existing test unparses
SELECT 1, which is identical across all four dialects.

Two smaller documentation problems sit in the same file:

  • the Dialect class summary reads "DataFusion data catalog."
  • with_pretty is documented as "Set the pretty flag.", which does not say
    what the flag changes.

Expected Behavior

All public functions in the module carry doctest-style usage examples,
consistent with the rest of the package and executed by pytest's
--doctest-modules.

Suggested Improvement

Add examples that unparse the same plan through each dialect so the differences
are visible, and correct the two docstrings noted above.

Lenguaje dominante
Python
Estrellas
605
Forks
176
Merge medio
1 d 23 h
PR fusionados (30 d)
8

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 apache/datafusion-python

Todos los issues de apache/datafusion-python

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.