[docs] [issue13875] cmd: no user documentation
report at bugs.python.org
Thu Jan 26 15:27:57 CET 2012
New submission from anatoly techtonik <techtonik at gmail.com>:
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` 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/
assignee: docs at python
nosy: docs at python, techtonik
title: cmd: no user documentation
Python tracker <report at bugs.python.org>
More information about the docs