Revision: 50acde4051d4
Author: Pekka Klärck
Date: Mon May 9 15:28:40 2011
Log: Keyword teardown docs: A small enhancement and example fix.
Update issue 711
Status: Done
Docs look good. Did a small enhancement and fixed the example, though.
http://code.google.com/p/robotframework/source/detail?r=50acde4051d4
Modified:
/doc/userguide/RobotFrameworkUserGuide.html
/doc/userguide/src/CreatingTestData/CreatingUserKeywords.txt
=======================================
--- /doc/userguide/RobotFrameworkUserGuide.html Mon May 9 15:12:51 2011
+++ /doc/userguide/RobotFrameworkUserGuide.html Mon May 9 15:28:40 2011
@@ -6818,12 +6818,14 @@
<h3><a class="toc-backref" href="#id398">2.6.6 Keyword
teardown</a></h3>
<p>Starting from Robot Framework 2.6, also user keywords may have a
teardown.
It is defined using <span class="opt">[Teardown]</span> setting.</p>
-<p>Keyword teardown works much in the same way as a <a class="reference
internal" href="#test-setup-and-teardown">test case teardown</a>.
-Most importantly, the teardown is always a single keyword and it gets
executed
-also when the user keyword fails. In addition, all steps of the teardown
-are executed even if one of them fails. However, a failure in keyword
teardown
-will fail the test case and subsequent steps in the test are not run. The
name
-of the keyword to be executed as a teardown can also be a variable.</p>
+<p>Keyword teardown works much in the same way as a <a class="reference
internal" href="#test-setup-and-teardown">test case
+teardown</a>. Most importantly, the teardown is always a single
+keyword, although it can be another user keyword, and it gets executed
+also when the user keyword fails. In addition, all steps of the
+teardown are executed even if one of them fails. However, a failure in
+keyword teardown will fail the test case and subsequent steps in the
+test are not run. The name of the keyword to be executed as a teardown
+can also be a variable.</p>
<table border="1" class="example docutils">
<colgroup>
<col width="26%" />
@@ -6840,8 +6842,12 @@
</thead>
<tbody valign="top">
<tr><td>With Teardown</td>
-<td>Do Something
-[Teardown]</td>
+<td>Do Something</td>
+<td> </td>
+<td> </td>
+</tr>
+<tr><td></td>
+<td>[Teardown]</td>
<td>Log</td>
<td>keyword teardown</td>
</tr>
@@ -14053,7 +14059,7 @@
<div class="footer">
<hr class="footer" />
<p>Generated by <a class="reference external"
href="http://docutils.sourceforge.net/rst.html";>reStructuredText</a>.
Syntax highlighting by <a class="reference external"
href="http://pygments.org/";>Pygments</a>.</p>
-<p>Generated on: 2011-05-09 22:12 UTC.
+<p>Generated on: 2011-05-09 22:24 UTC.
</p>
</div>
=======================================
--- /doc/userguide/src/CreatingTestData/CreatingUserKeywords.txt Mon May 9
07:32:10 2011
+++ /doc/userguide/src/CreatingTestData/CreatingUserKeywords.txt Mon May 9
15:28:40 2011
@@ -417,12 +417,14 @@
Starting from Robot Framework 2.6, also user keywords may have a teardown.
It is defined using :opt:`[Teardown]` setting.
-Keyword teardown works much in the same way as a `test case teardown`__.
-Most importantly, the teardown is always a single keyword and it gets
executed
-also when the user keyword fails. In addition, all steps of the teardown
-are executed even if one of them fails. However, a failure in keyword
teardown
-will fail the test case and subsequent steps in the test are not run. The
name
-of the keyword to be executed as a teardown can also be a variable.
+Keyword teardown works much in the same way as a `test case
+teardown`__. Most importantly, the teardown is always a single
+keyword, although it can be another user keyword, and it gets executed
+also when the user keyword fails. In addition, all steps of the
+teardown are executed even if one of them fails. However, a failure in
+keyword teardown will fail the test case and subsequent steps in the
+test are not run. The name of the keyword to be executed as a teardown
+can also be a variable.
.. table::
:class: example
@@ -431,7 +433,7 @@
User Keyword Action Argument Argument
================== =============== ===================
==================
With Teardown Do Something
- [Teardown] Log keyword
teardown
+ \ [Teardown] Log keyword
teardown
\
Using variables [Documentation] Teardown given as variable
\ Do Something
