apache / apache/datafusion-python
Doc improvements
- Linguagem predominante
- Python
- Estrelas
- 604
- Forks
- 174
- Merge médio
- 2d 22h
- PRs com merge (30d)
- 5
Descrição
**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.
Guia de contribuição
Nenhum guia de contribuição indexado para este repositório
Direção de pesquisa
Comece lendo python/datafusion/functions.py e comparando o alias docstring com os outros function docstrings. Identifique as funções cujos argumentos não têm descrições e documente-as de forma consistente com o exemplo existente. O trabalho estará concluído quando todos os function docstrings nesse arquivo incluírem documentação para seus argumentos.
Escrita pelo modelo de indexação a partir do texto da issue.
Avaliação
- Stack de tecnologia
- python
- Domínio
- documentation
- Tipo de issue
- Documentação
- Dificuldade
- 3/5
- Tempo estimado
- 1-2 dias
- Status de atividade
- Pouca atividade
- Clareza
- Razoavelmente clara
- Facilidade para iniciantes
- 72/100