r4488 - /1.3/prompt/interpreter.py -- January 08, 2008 - 16:04

Author: bugman
Date: Tue Jan  8 15:42:44 2008
New Revision: 4488

URL: http://svn.gna.org/viewcvs/relax?rev=4488&view=rev
Log:
Converted the interact_prompt() args to keyword args and epydoc'd the 
docstring.


Modified:
    1.3/prompt/interpreter.py

Modified: 1.3/prompt/interpreter.py
URL: 
http://svn.gna.org/viewcvs/relax/1.3/prompt/interpreter.py?rev=4488&r1=4487&r2=4488&view=diff
==============================================================================
--- 1.3/prompt/interpreter.py (original)
+++ 1.3/prompt/interpreter.py Tue Jan  8 15:42:44 2008
@@ -308,10 +308,17 @@
         sys.exit()
 
 
-def interact_prompt(self, intro, local):
+def interact_prompt(self, intro=None, local={}):
     """Replacement function for 'code.InteractiveConsole.interact'.
 
     This will enter into the prompt.
+
+    @param intro:   The string to print prior to jumping to the prompt mode.
+    @type intro:    str
+    @param local:   A namespace which will become that of the prompt (i.e. 
the namespace visible to
+                    the user when in the prompt mode).  This should be the 
output of a function such
+                    as locals().
+    @type local:    dict
     """
 
     # Print the program introduction.