r4490 - /1.3/prompt/interpreter.py -- January 08, 2008 - 16:21

Author: bugman
Date: Tue Jan  8 16:21:23 2008
New Revision: 4490

URL: http://svn.gna.org/viewcvs/relax?rev=4490&view=rev
Log:
Updated the prompt() docstring for the epydoc format.


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=4490&r1=4489&r2=4490&view=diff
==============================================================================
--- 1.3/prompt/interpreter.py (original)
+++ 1.3/prompt/interpreter.py Tue Jan  8 16:21:23 2008
@@ -457,6 +457,14 @@
     """Python interpreter emulation.
 
     This function replaces 'code.interact'.
+
+
+    @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
     """
 
     # Replace the 'InteractiveConsole.interact' and 
'InteractiveConsole.runcode' functions.