Add a tutorial for cmd.Cmd for `emptyline()` and `do_EOF`
Personne n'a encore pris cette issue.
- Langage dominant
- Python
- Étoiles
- 77.2k
- Forks
- 35.9k
- Métriques de merge des PR
- Métriques de PR en attente
Description
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
Guide de contribution
Ouvrir le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Piste de recherche
Commencez par la documentation de cmd.Cmd et issue #143804 afin de comprendre les explications existantes au niveau des méthodes et la confusion signalée. Ajoutez un tutoriel au niveau de l’utilisation couvrant emptyline() et do_EOF, y compris le comportement attendu et une sortie propre, puis vérifiez que la documentation explique clairement ces deux redéfinitions.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- python
- Domaine
- documentation
- Type d'issue
- Documentation
- Difficulté
- 2/5
- Temps estimé
- 1-3 heures
- Activité
- À l'abandon
- Clarté
- Plutôt claire
- Accessibilité débutants
- 35/100