Missing docstring examples in the `unparser` module

未关闭 适合新手
#1,691 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
2/5
预计耗时
半天
新手友好度
88/100
Issue 类型
文档
描述清晰度
描述清楚
活跃度
活跃
技术栈
python
领域
documentation

调研方向

从 python/datafusion/unparser.py 开始，阅读现有的 Dialect 和 Unparser 文档字符串，然后检查当前的 SELECT 1 unparser 测试以了解设置方式。添加展示方言差异的 doctest 风格示例，明确 Dialect 和 with_pretty 的摘要，并运行带有 --doctest-modules 的 pytest。所有列出的 public 函数都具有通过测试的使用示例，并且措辞已得到修正，即表示完成。

由索引模型根据 Issue 内容生成。

描述

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.

主要语言
Python
星标
605
派生
176
平均合并
1 天 23 小时
30 天内合并 PR
8

贡献指南

这个仓库没有索引到贡献指南

从这里开始

  1. 先读完整个 Issue，再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库，在一个分支上完成修改。
  4. 提交 Pull Request，并在描述里引用这个 Issue 编号。

apache/datafusion-python 的其他 Issue

查看 apache/datafusion-python 的全部 Issue

相似的 Issue

更多 Python Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。