Author: pekka.klarck
Date: Tue Apr 7 12:45:09 2009
New Revision: 1731
Modified:
trunk/doc/libraries/BuiltIn.html
trunk/src/robot/libraries/BuiltIn.py
Log:
doc update
Modified: trunk/doc/libraries/BuiltIn.html
==============================================================================
--- trunk/doc/libraries/BuiltIn.html (original)
+++ trunk/doc/libraries/BuiltIn.html Tue Apr 7 12:45:09 2009
@@ -909,7 +909,7 @@
<br />
Variables set with this keyword are available everywhere within the scope
of the currently executed test suite. Setting variables with this keyword
thus has the same effect as creating them using the Variable table in the
test data file or importing them from variable files. Other test suites,
including possible child test suites, will not see variables set with this
keyword.<br />
<br />
-The name of the variable can be given either as a normal variable name
(e.g. ${NAME}) or in escaped format (e.g. \${NAME}), but the former works
only in Robot Framework 2.1 and newer.<br />
+The name of the variable can be given either as a normal variable name
(e.g. ${NAME}) or in escaped format (e.g. \${NAME}). Notice that the former
works only in Robot Framework 2.1 and newer.<br />
<br />
If a variable already exists within the new scope, its value will be
overwritten. Otherwise a new variable is created. If a variable already
exists within the current scope, the value can be left empty and the
variable within the new scope gets the value within the current scope.<br />
<br />
@@ -1457,7 +1457,7 @@
<td class="arg">name, msg=None</td>
<td class="doc">Fails unless the given variable exists within the
current scope.<br />
<br />
-The variable name must be given in the escaped format, e.g. \${scalar} or
\...@{list} to prevent it from being resolved. Alternatively, in this case, it
is possible to give the variable name in a special format without curly
braces, e.g. $scalar or @list.<br />
+The name of the variable can be given either as a normal variable name
(e.g. ${NAME}) or in escaped format (e.g. \${NAME}). Notice that the former
works only in Robot Framework 2.1 and newer.<br />
<br />
The default error message can be overridden with the <span
class="name">msg</span> argument.</td>
</tr>
@@ -1466,7 +1466,7 @@
<td class="arg">name, msg=None</td>
<td class="doc">Fails if the given variable exists within the current
scope.<br />
<br />
-The variable name must be given in the escaped format, e.g. \${scalar} or
\...@{list} to prevent it from being resolved. Alternatively, in this case, it
is possible to give the variable name in the special format without curly
braces, e.g. $scalar or @list.<br />
+The name of the variable can be given either as a normal variable name
(e.g. ${NAME}) or in escaped format (e.g. \${NAME}). Notice that the former
works only in Robot Framework 2.1 and newer.<br />
<br />
The default error message can be overridden with the <span
class="name">msg</span> argument.</td>
</tr>
@@ -1496,7 +1496,7 @@
<p class="footer">
Altogether 73 keywords.<br />
Generated by <a
href="http://code.google.com/p/robotframework/wiki/LibraryDocumentationTool";>libdoc.py</a>
-on 2009-04-07 18:15:28.
+on 2009-04-07 22:44:37.
</p>
</body>
</html>
Modified: trunk/src/robot/libraries/BuiltIn.py
==============================================================================
--- trunk/src/robot/libraries/BuiltIn.py (original)
+++ trunk/src/robot/libraries/BuiltIn.py Tue Apr 7 12:45:09 2009
@@ -548,10 +548,9 @@
def variable_should_exist(self, name, msg=None):
"""Fails unless the given variable exists within the current scope.
- The variable name must be given in the escaped format, e.g.
\\${scalar}
- or \...@{list} to prevent it from being resolved. Alternatively, in
this
- case, it is possible to give the variable name in a special format
- without curly braces, e.g. $scalar or @list.
+ The name of the variable can be given either as a normal variable
name
+ (e.g. ${NAME}) or in escaped format (e.g. \\${NAME}). Notice that
the
+ former works only in Robot Framework 2.1 and newer.
The default error message can be overridden with the `msg`
argument.
"""
@@ -566,10 +565,9 @@
def variable_should_not_exist(self, name, msg=None):
"""Fails if the given variable exists within the current scope.
- The variable name must be given in the escaped format, e.g.
\\${scalar}
- or \...@{list} to prevent it from being resolved. Alternatively, in
this
- case, it is possible to give the variable name in the special
format
- without curly braces, e.g. $scalar or @list.
+ The name of the variable can be given either as a normal variable
name
+ (e.g. ${NAME}) or in escaped format (e.g. \\${NAME}). Notice that
the
+ former works only in Robot Framework 2.1 and newer.
The default error message can be overridden with the `msg`
argument.
"""
@@ -658,8 +656,8 @@
variables set with this keyword.
The name of the variable can be given either as a normal variable
name
- (e.g. ${NAME}) or in escaped format (e.g. \\${NAME}), but the
former
- works only in Robot Framework 2.1 and newer.
+ (e.g. ${NAME}) or in escaped format (e.g. \\${NAME}). Notice that
the
+ former works only in Robot Framework 2.1 and newer.
If a variable already exists within the new scope, its value will
be
overwritten. Otherwise a new variable is created. If a variable
already
