Doc improvements
还没有人认领这个 Issue。
评估
- 难度
- 3/5
- 预计耗时
- 1-2 天
- 新手友好度
- 72/100
- Issue 类型
- 文档
- 描述清晰度
- 基本清楚
- 活跃度
- 冷清
- 技术栈
- python
调研方向
首先阅读 python/datafusion/functions.py，并将 alias docstring 与其他 function docstrings 进行比较。找出参数缺少描述的函数，并参照现有示例以一致的方式为它们编写文档。当该文件中的所有 function docstrings 都包含参数文档时，工作即告完成。
由索引模型根据 Issue 内容生成。
描述
Is your feature request related to a problem or challenge? Please describe what you are trying to do.
I'm trying to use documentation to understand the arguments to functions in functions.py.
Describe the solution you'd like
I'd love if all the function docstrings had documentation for the arguments to the function. For example, alias has descriptions of its arguments.
Describe alternatives you've considered
None, really, just recording it as a unit of work that would improve the project.
Additional context
This is a follow-on issue to @ntjohnson1 excellent work in https://github.com/apache/datafusion-python/pull/1435 where he added tons of helpful examples. I was browsing the code in the PR and realized quite a few functions were missing argument documentation.
- 主要语言
- Python
- 星标
- 605
- 派生
- 176
- 平均合并
- 1 天 23 小时
- 30 天内合并 PR
- 8
贡献指南
这个仓库没有索引到贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
apache/datafusion-python 的其他 Issue
-
documentation
难度 2/5 1-3 小时 新手友好度 72/100
apache/datafusion-python#1726 ·
-
难度 2/5 半天 新手友好度 88/100
apache/datafusion-python#1691 ·
-
bug
难度 2/5 1-3 小时 新手友好度 78/100
apache/datafusion-python#1644 ·
-
enhancement
难度 5/5 一周以上 新手友好度 30/100
apache/datafusion-python#1737 ·
-
难度 3/5 1-2 天 新手友好度 76/100
apache/datafusion-python#1735 · 1 条评论 ·
查看 apache/datafusion-python 的全部 Issue
相似的 Issue
-
bug
难度 2/5 1-3 小时 新手友好度 90/100
learningequality/ricecooker#747 ·
-
难度 2/5 1-3 小时 新手友好度 68/100
BSData/horus-heresy-3rd-edition#3171 ·
-
enhancement
难度 2/5 1-3 小时 新手友好度 72/100
-
难度 2/5 1-3 小时 新手友好度 76/100
run-llama/llama_index#23199 ·
-
难度 2/5 1-3 小时 新手友好度 84/100
KhronosGroup/glTF-Blender-IO#2769 ·