This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

Author techtonik
Recipients docs@python, techtonik
Date 2012-01-26.14:27:56
SpamBayes Score 0.0017220594
Marked as misclassified No
Message-id <1327588077.77.0.0954132482021.issue13875@psf.upfronthosting.co.za>
In-reply-to
Content
http://docs.python.org/library/cmd.html#

Documentation for cmd module is poor to explain the value of this module to users. Intro is too abstract - phrase "simple framework for writing line-oriented command interpreters" doesn't mean much. Perhaps word "interactive" is missing?

So, there is no part explaining the what cmd does exactly (intro fails) and no part explaining the main principle - How exactly does this framework allows to do this in a simple way? (I guess reference part under 'Cmd objects -> Cmd.cmdloop([intro]) -> p[4]` does that, but it is not the place you'd usually expect this info.

At the very least what could be done is a link to Doug's tutorial http://www.doughellmann.com/PyMOTW/cmd/
History
Date User Action Args
2012-01-26 14:27:57techtoniksetrecipients: + techtonik, docs@python
2012-01-26 14:27:57techtoniksetmessageid: <1327588077.77.0.0954132482021.issue13875@psf.upfronthosting.co.za>
2012-01-26 14:27:57techtoniklinkissue13875 messages
2012-01-26 14:27:56techtonikcreate