changeset 329:c69ad8418d39

free function docs
author cat@eee
date Fri, 12 Feb 2010 15:55:38 -0500
parents 7b2bca3951a7
children 3aca8af5971f
files cmd2.py docs/freefeatures.rst
diffstat 2 files changed, 15 insertions(+), 2 deletions(-) [+]
line wrap: on
line diff
--- a/cmd2.py	Fri Feb 12 15:35:48 2010 -0500
+++ b/cmd2.py	Fri Feb 12 15:55:38 2010 -0500
@@ -1129,9 +1129,11 @@
                   pyparsing.stringEnd)    
     def do_save(self, arg):
         """`save [N] [filename.ext]`
+
         Saves command from history to file.
-        N => Number of command (from history), or `*`; 
-             most recent command if omitted"""
+
+        | N => Number of command (from history), or `*`; 
+        |      most recent command if omitted"""
 
         try:
             args = self.saveparser.parseString(arg)
--- a/docs/freefeatures.rst	Fri Feb 12 15:35:48 2010 -0500
+++ b/docs/freefeatures.rst	Fri Feb 12 15:55:38 2010 -0500
@@ -102,5 +102,16 @@
 
 .. automethod:: cmd2.Cmd.do_history
 
+.. automethod:: cmd2.Cmd.do_list
+
+.. automethod:: cmd2.Cmd.do_run
+
+Quitting the application
+========================
+
+``cmd2`` pre-defines a ``quit`` command for you (with 
+synonyms ``exit`` and simply ``q``).
+It's trivial, but it's one less thing for you to remember.
+
 Transcript-based testing
 ========================