Add a tutorial for cmd.Cmd for `emptyline()` and `do_EOF`
Ninguém assumiu esta issue ainda.
- Linguagem predominante
- Python
- Estrelas
- 77.2k
- Forks
- 35.9k
- Métricas de merge de PRs
- Métricas de PR pendentes
Descrição
Documentation
This is w.r.t the issue #143804
It was pointed out it is not a bug (agreed) but we can improve the documentation of this module
since it is now not very clear that
- One has to over-ride "emptyline" so that the last line is not repeated
- One has to over-ride do_EOF to quit cleanly
A tutorial on this in the documentation would be helpful as right now these are at the level of method level documentation and quite unclear at the usage level.
Linked PRs
- gh-145292
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.
Direção de pesquisa
Comece pela documentação de cmd.Cmd e por issue #143804 para entender as explicações existentes em nível de método e a confusão relatada. Adicione um tutorial em nível de uso que aborde emptyline() e do_EOF, incluindo o comportamento esperado e uma saída limpa; em seguida, verifique se a documentação explica claramente ambas as sobrescritas.
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
- 2/5
- Tempo estimado
- 1-3 horas
- Status de atividade
- Estagnada
- Clareza
- Razoavelmente clara
- Facilidade para iniciantes
- 35/100