Revision: 3900
Author: jussi.ao.malinen
Date: Wed Aug 25 03:36:16 2010
Log: doc string for exit_for_loop
http://code.google.com/p/robotframework/source/detail?r=3900
Modified:
/trunk/src/robot/libraries/BuiltIn.py
=======================================
--- /trunk/src/robot/libraries/BuiltIn.py Wed Aug 25 03:05:46 2010
+++ /trunk/src/robot/libraries/BuiltIn.py Wed Aug 25 03:36:16 2010
@@ -141,7 +141,11 @@
raise error
def exit_for_loop(self):
- """TODO
+ """Immediately stops executing enclosing for loop and continues
+ execution after the for loop normally.
+
+ This keyword can be used inside a keyword to exit a for loop in
test
+ case or calling keyword. If executed outside of a for loop, the
test fails.
"""
# Error message is shown only if there is no eclosing for loop
error = AssertionError('Exit for loop without enclosing for loop.')
