PROPOSAL: Update docs
Ninguém assumiu esta issue ainda.
Avaliação
- Dificuldade
- 5/5
- Tempo estimado
- Mais de uma semana
- Facilidade para iniciantes
- 20/100
- Tipo de issue
- Documentação
- Clareza
- Precisa de esclarecimento
- Status de atividade
- Estagnada
- Stack de tecnologia
- python
- Domínio
- documentation
Direção de pesquisa
Start by reviewing the current documentation and the library's public APIs to identify outdated or unclear sections. Also inspect the codebase for places where developer-facing comments or TODOs could improve understanding. Done requires an agreed documentation scope and a decision on whether issue tags and code comments belong in this effort.
Escrita pelo modelo de indexação a partir do texto da issue.
Descrição
I know we talked about updating the documentation so that it is more current and reads better (not that it doesn't read well now, but I feel certain API/aspects of the library can be put forward in a little cleaner fashion).
I suggest we also add some comments/TODOs in the codebase if possible so that it is more understandable to developers. But this is just my opinion.
Any suggestions on how we can start the process, and what all needs to be done?
I think it would also be immensely beneficial if we add tags to our issues — bugs, feature requests, proposals, maybe more. What do you guys think?
- Linguagem predominante
- Python
- Estrelas
- 1.3k
- Forks
- 149
- Métricas de merge de PRs
- Nenhum PR com merge em 30d
Guia de contribuição
Primeiros passos
- Leia a issue inteira e depois o guia de contribuição do projeto.
- Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
- Faça um fork do repositório e trabalhe em uma branch.
- Abra um pull request que referencie o número da issue.
Mais de python-streamz/streamz
-
pkg_resources warning Aberta
Dificuldade 3/5 1-2 dias Facilidade para iniciantes 35/100
python-streamz/streamz#481 · 4 comentários ·
-
Combining the streamz.Stream.filenames() and streamz.Stream.from_textfile() using dask scatter? Aberta
Dificuldade 5/5 Mais de uma semana Facilidade para iniciantes 25/100
python-streamz/streamz#480 · 2 comentários ·
-
Compile the code into c++ Aberta
Dificuldade 5/5 Mais de uma semana Facilidade para iniciantes 20/100
python-streamz/streamz#479 · 1 comentário ·
-
Dificuldade 5/5 Mais de uma semana Facilidade para iniciantes 20/100
python-streamz/streamz#478 · 6 comentários ·
-
Dificuldade 4/5 3-5 dias Facilidade para iniciantes 10/100
python-streamz/streamz#476 · 17 comentários · 2 reações ·
Todas as issues de python-streamz/streamz
Issues semelhantes
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 88/100
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 82/100
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 78/100
-
enhancement
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 72/100
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 74/100