2 new revisions:
Revision: 81cd63f3d5fd
Branch: default
Author: Jussi Malinen <jussi.ao.mali...@gmail.com>
Date: Tue Sep 17 14:20:32 2013 UTC
Log: cleanup documentation for ROBOT_SUPPRESS_NAME
http://code.google.com/p/robotframework/source/detail?r=81cd63f3d5fd
Revision: c1b14ee336f6
Branch: default
Author: Jussi Malinen <jussi.ao.mali...@gmail.com>
Date: Tue Sep 17 14:20:38 2013 UTC
Log: regen
http://code.google.com/p/robotframework/source/detail?r=c1b14ee336f6
==============================================================================
Revision: 81cd63f3d5fd
Branch: default
Author: Jussi Malinen <jussi.ao.mali...@gmail.com>
Date: Tue Sep 17 14:20:32 2013 UTC
Log: cleanup documentation for ROBOT_SUPPRESS_NAME
http://code.google.com/p/robotframework/source/detail?r=81cd63f3d5fd
Modified:
/doc/userguide/src/ExtendingRobotFramework/CreatingTestLibraries.rst
=======================================
--- /doc/userguide/src/ExtendingRobotFramework/CreatingTestLibraries.rst
Tue Sep 17 14:15:19 2013 UTC
+++ /doc/userguide/src/ExtendingRobotFramework/CreatingTestLibraries.rst
Tue Sep 17 14:20:32 2013 UTC
@@ -895,11 +895,24 @@
others, the message is created in the format :msg:`ExceptionType:
Actual message`.
-Since Robot Framework 2.8.2 it is possible to add a special
-:code:`ROBOT_SUPPRESS_NAME` attribute with value :code:`True` to your
exception
-if you want to use some other exception type besides the generic
exceptions,
-but also to suppress adding the exception type as a prefix to failure
-message.
+Starting from Robot Framework 2.8.2 it is possible to avoid adding the
+exception type as a prefix to failure message also with non generic
exceptions.
+This is done by adding a special :code:`ROBOT_SUPPRESS_NAME` attribute with
+value :code:`True` to your exception.
+
+Python:
+
+.. sourcecode:: python
+
+ class MyError(RuntimeError):
+ ROBOT_SUPPRESS_NAME = True
+
+Java:
+
+.. sourcecode:: java
+
+ public class MyError extends RuntimeException {
+ public static final boolean ROBOT_SUPPRESS_NAME = true;
In all cases, it is important for the users that the exception message is
as
informative as possible.
==============================================================================
Revision: c1b14ee336f6
Branch: default
Author: Jussi Malinen <jussi.ao.mali...@gmail.com>
Date: Tue Sep 17 14:20:38 2013 UTC
Log: regen
http://code.google.com/p/robotframework/source/detail?r=c1b14ee336f6
Modified:
/doc/userguide/RobotFrameworkUserGuide.html
=======================================
--- /doc/userguide/RobotFrameworkUserGuide.html Tue Sep 17 14:15:26 2013 UTC
+++ /doc/userguide/RobotFrameworkUserGuide.html Tue Sep 17 14:20:38 2013 UTC
@@ -12958,11 +12958,18 @@
<span class="code">RuntimeError</span>), only the exception message is
used, and with
others, the message is created in the format <span
class="msg">ExceptionType:
Actual message</span>.</p>
-<p>Since Robot Framework 2.8.2 it is possible to add a special
-<span class="code">ROBOT_SUPPRESS_NAME</span> attribute with value <span
class="code">True</span> to your exception
-if you want to use some other exception type besides the generic
exceptions,
-but also to suppress adding the exception type as a prefix to failure
-message.</p>
+<p>Starting from Robot Framework 2.8.2 it is possible to avoid adding the
+exception type as a prefix to failure message also with non generic
exceptions.
+This is done by adding a special <span
class="code">ROBOT_SUPPRESS_NAME</span> attribute with
+value <span class="code">True</span> to your exception.</p>
+<p>Python:</p>
+<div class="highlight"><pre><span class="k">class</span> <span
class="nc">MyError</span><span class="p">(</span><span
class="ne">RuntimeError</span><span class="p">):</span>
+ <span class="n">ROBOT_SUPPRESS_NAME</span> <span class="o">=</span>
<span class="bp">True</span>
+</pre></div>
+<p>Java:</p>
+<div class="highlight"><pre><span class="kd">public</span> <span
class="kd">class</span> <span class="nc">MyError</span> <span
class="kd">extends</span> <span class="n">RuntimeException</span> <span
class="o">{</span>
+ <span class="kd">public</span> <span class="kd">static</span> <span
class="kd">final</span> <span class="kt">boolean</span> <span
class="n">ROBOT_SUPPRESS_NAME</span> <span class="o">=</span> <span
class="kc">true</span><span class="o">;</span>
+</pre></div>
<p>In all cases, it is important for the users that the exception message
is as
informative as possible.</p>
<div class="section" id="html-in-error-messages">
@@ -17158,7 +17165,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: 2013-09-17 14:14 UTC.
+<p>Generated on: 2013-09-17 14:19 UTC.
</p>
</div>
--
---
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 robotframework-commit+unsubscr...@googlegroups.com.
For more options, visit https://groups.google.com/groups/opt_out.
