Add a tutorial for cmd.Cmd for `emptyline()` and `do_EOF`
Open
Nobody has claimed this yet.
docs
triaged
- Dominant language
- Python
- Stars
- 77.2k
- Forks
- 35.9k
- PR merge metrics
- PR metrics pending
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
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the cmd.Cmd documentation and issue #143804 to understand the existing method-level explanations and the reported confusion. Add a usage-level tutorial covering emptyline() and do_EOF, including the expected behavior and clean exit, then verify that the documentation clearly explains both overrides.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100