Update documentation to use generators
@aashraybhandar1 já está trabalhando nisso.
Desde 7/4/2018.
Avaliação
- Dificuldade
- 2/5
- Tempo estimado
- 1-3 horas
- Facilidade para iniciantes
- 45/100
- Tipo de issue
- Documentação
- Clareza
- Razoavelmente clara
- Status de atividade
- Estagnada
- Stack de tecnologia
- python
- Domínio
- cli, documentation
Direção de pesquisa
Comece lendo as seções da documentação de quick-start e API que descrevem a saída de CLI Helpers como uma lista. Atualize essas referências para que descrevam geradores e, em seguida, verifique se ambas as áreas da documentação refletem de forma consistente o comportamento atual.
Escrita pelo modelo de indexação a partir do texto da issue.
Descrição
The current documentation assumes that the output format is a list, but CLI Helpers now returns generators. We should update the quick start and the API documentation.
- Linguagem predominante
- Python
- Estrelas
- 104
- Forks
- 33
- Métricas de merge de PRs
- Nenhum PR com merge em 30d
Preparar o ambiente
- Sem Dockerfile nem arquivo Docker Compose
- Tem um modelo de pull request
- Ler o 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 dbcli/cli_helpers
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 45/100
dbcli/cli_helpers#50 · 2 comentários ·
Todas as issues de dbcli/cli_helpers
Issues semelhantes
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 62/100
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 72/100
Mantenedores costumam responder em até 1 dia
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 74/100
WingedGuardian/GENesis-AGI#3375 ·
Mantenedores costumam responder em até 1 dia
-
curriculum documentation quality
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 75/100
githubnext/gh-aw-workshop#4601 ·
Mantenedores costumam responder em até 1 dia
-
approved Good First Issue scope: docs
Dificuldade 1/5 Menos de uma hora Facilidade para iniciantes 85/100
hiero-ledger/hiero-sdk-python#2730 · 3 comentários ·
Mantenedores costumam responder em até 1 dia