Author: bugman Date: Tue Jan 8 16:22:33 2008 New Revision: 4491 URL: http://svn.gna.org/viewcvs/relax?rev=4491&view=rev Log: Updated the run_script() 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=4491&r1=4490&r2=4491&view=diff ============================================================================== --- 1.3/prompt/interpreter.py (original) +++ 1.3/prompt/interpreter.py Tue Jan 8 16:22:33 2008 @@ -480,6 +480,25 @@ """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 + @param script_file: The script file to be executed. + @type script_file: None or str + @param quit: If true, the default, then relax will exit after running the script. + @type quit: bool + @param show_script: If true, the relax will print the script contents prior to executing + the script. + @type show_script: bool + @param raise_relax_error: If false, the default, then a nice error message will be sent to + STDERR, without a traceback, when a RelaxError occurs. This is to + make things nicer for the user. + @type raise_relax_error: bool """ # Replace the 'InteractiveConsole.interact' and 'InteractiveConsole.runcode' functions.