Revision: dd314b0d94c0
Branch:   default
Author:   Tatu Kairi <[email protected]>
Date:     Fri May 24 06:04:15 2013
Log:      Keyword documentation for Pass Execution.

Update issue 174
Status: review

Keyword documentation done. Issue ready for review.
http://code.google.com/p/robotframework/source/detail?r=dd314b0d94c0

Modified:
 /src/robot/libraries/BuiltIn.py

=======================================
--- /src/robot/libraries/BuiltIn.py     Fri May 24 05:15:17 2013
+++ /src/robot/libraries/BuiltIn.py     Fri May 24 06:04:15 2013
@@ -812,6 +812,30 @@
         return msg

     def pass_execution(self, message, *tags):
+        """Skips the rest of the current test execution with status PASS.
+
+ The message is specified using the `msg` argument. It is possible to + use HTML in the given message by prefixing the message with `*HTML*`.
+
+ It is possible to modify tags of the current test case by passing tags + after the message. Tags starting with a hyphen (e.g. `-regression`) are
+        removed and others added. Tags are modified using `Set Tags` and
+ `Remove Tags` internally, and the semantics setting and removing them
+        are the same as with these keywords.
+
+        If this keyword is used outside a test teardown, the message is
+        overridden by possible failure message. Failures in teardown
+        are always shown in addition to this message.
+
+        Examples:
+ | Pass Execution | Skip rest of the test | | | # Passes the current test case with the given message. | + | Pass Execution | *HTML*<b>Skip rest of the test</b> | | | # Passes the current test case using HTML in the message. | + | Pass Execution | No need to go further | case-ok | | # Fails and adds 'case-ok' tag. | + | Pass Execution | Deprecated | -regression | | # Removes tag 'regression'. | + | Pass Execution | My message | tag | -t* | # Removes all tags starting with 't' except the newly added 'tag'. |
+
+        New in Robot Framework 2.8.
+        """
         message = message.strip()
         if not message:
             raise RuntimeError('Message cannot be empty.')

--

--- You received this message because you are subscribed to the Google Groups "robotframework-commit" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to [email protected].
For more options, visit https://groups.google.com/groups/opt_out.


Reply via email to