summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRaymond Hettinger <python@rcn.com>2010-09-09 03:53:22 (GMT)
committerRaymond Hettinger <python@rcn.com>2010-09-09 03:53:22 (GMT)
commit44d7b6ad60c151d2a265c326c1f7cf26d3c9dc18 (patch)
treed294781112900852e67666d7965abb1f6bc97c5f
parentbd889e8c40da62b4a2aaa99d2b1ef50291b49342 (diff)
downloadcpython-44d7b6ad60c151d2a265c326c1f7cf26d3c9dc18.zip
cpython-44d7b6ad60c151d2a265c326c1f7cf26d3c9dc18.tar.gz
cpython-44d7b6ad60c151d2a265c326c1f7cf26d3c9dc18.tar.bz2
Add docstring to cmd.Cmd.do_help()
-rw-r--r--Doc/library/cmd.rst4
-rw-r--r--Lib/cmd.py1
-rw-r--r--Lib/test/test_cmd.py8
3 files changed, 5 insertions, 8 deletions
diff --git a/Doc/library/cmd.rst b/Doc/library/cmd.rst
index b72a49f..d713b8f 100644
--- a/Doc/library/cmd.rst
+++ b/Doc/library/cmd.rst
@@ -312,10 +312,6 @@ blank lines to repeat commands, and the simple record and playback facility::
bye color goto home playback record right
circle forward heading left position reset undo
- Undocumented commands:
- ======================
- help
-
(turtle) help forward
Move the turtle forward by the specified distance: FORWARD 10
(turtle) record spiral.cmd
diff --git a/Lib/cmd.py b/Lib/cmd.py
index 85282f8..8fa7d01 100644
--- a/Lib/cmd.py
+++ b/Lib/cmd.py
@@ -288,6 +288,7 @@ class Cmd:
return list(commands | topics)
def do_help(self, arg):
+ 'List available commands with "help" or detailed help with "help cmd".'
if arg:
# XXX check arg syntax
try:
diff --git a/Lib/test/test_cmd.py b/Lib/test/test_cmd.py
index 75aa6bb..a1799f9 100644
--- a/Lib/test/test_cmd.py
+++ b/Lib/test/test_cmd.py
@@ -84,11 +84,11 @@ class samplecmdclass(cmd.Cmd):
<BLANKLINE>
Documented commands (type help <topic>):
========================================
- add
+ add help
<BLANKLINE>
Undocumented commands:
======================
- exit help shell
+ exit shell
<BLANKLINE>
Test for the function print_topics():
@@ -125,11 +125,11 @@ class samplecmdclass(cmd.Cmd):
<BLANKLINE>
Documented commands (type help <topic>):
========================================
- add
+ add help
<BLANKLINE>
Undocumented commands:
======================
- exit help shell
+ exit shell
<BLANKLINE>
help text for add
Hello from postloop