apache / apache/datafusion-python
Doc improvements
- Ngôn ngữ chính
- Python
- Star
- 604
- Fork
- 174
- Merge trung bình
- 1 ngày 7 giờ
- Pull request đã merge (30 ngày)
- 4
Mô tả
**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`](https://github.com/apache/datafusion-python/blob/ad8d41f2b5faff9a35aeeb340a24480c8ccb6eff/python/datafusion/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](https://github.com/apache/datafusion-python/blob/ad8d41f2b5faff9a35aeeb340a24480c8ccb6eff/python/datafusion/functions.py#L494-L497).
**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.
Hướng dẫn đóng góp
Chưa lập chỉ mục được hướng dẫn đóng góp cho kho mã nguồn này
Đánh giá
Issue này chưa được đánh giá.