Missing docstring examples in the `unparser` module
Personne n'a encore pris cette issue.
Évaluation
- Difficulté
- 2/5
- Temps estimé
- Une demi-journée
- Accessibilité débutants
- 88/100
- Type d'issue
- Documentation
- Clarté
- Clairement spécifiée
- Activité
- Active
- Stack technique
- python
- Domaine
- documentation
Piste de recherche
Commencez dans python/datafusion/unparser.py et lisez les docstrings existantes de Dialect et Unparser, puis examinez le test actuel de l’unparser pour SELECT 1 afin d’en comprendre la configuration. Ajoutez des exemples de style doctest montrant les différences entre les dialectes, clarifiez les résumés de Dialect et de with_pretty, puis exécutez pytest avec --doctest-modules. C’est terminé lorsque toutes les fonctions publiques listées disposent d’exemples d’utilisation réussis et que la formulation a été corrigée.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Description
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.defaultDialect.mysqlDialect.postgresDialect.sqliteDialect.duckdbUnparser.plan_to_sqlUnparser.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
Dialectclass summary reads"DataFusion data catalog." with_prettyis 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.
- Langage dominant
- Python
- Étoiles
- 605
- Forks
- 176
- Merge moyen
- 1 j 23 h
- PR mergées (30 j)
- 8
Guide de contribution
Aucun guide de contribution indexé pour ce dépôt
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Autres issues de apache/datafusion-python
-
enhancement
Difficulté 2/5 1-3 heures Accessibilité débutants 70/100
apache/datafusion-python#1757 ·
-
documentation
Difficulté 2/5 1-3 heures Accessibilité débutants 72/100
apache/datafusion-python#1726 ·
-
bug
Difficulté 2/5 1-3 heures Accessibilité débutants 78/100
apache/datafusion-python#1644 ·
-
enhancement
Difficulté 5/5 Plus d'une semaine Accessibilité débutants 30/100
apache/datafusion-python#1737 ·
-
Difficulté 3/5 1-2 jours Accessibilité débutants 76/100
apache/datafusion-python#1735 · 1 commentaire ·
Toutes les issues de apache/datafusion-python
Issues similaires
-
bug confirmed issue
Difficulté 2/5 1-3 heures Accessibilité débutants 75/100
open-webui/open-webui#30750 · 1 commentaire ·
-
Difficulté 2/5 1-3 heures Accessibilité débutants 75/100
-
enhancement
Difficulté 2/5 1-3 heures Accessibilité débutants 75/100
OpenwaterHealth/openmotion-bloodflow-app#604 · 1 commentaire ·
-
Difficulté 2/5 1-3 heures Accessibilité débutants 70/100
-
good first issue
Difficulté 1/5 Moins d'une heure Accessibilité débutants 90/100