Documentation enhancements

pekkaklarck · pekkaklarck · commit 38c4616a3880 · 2025-05-07T17:38:25.000+03:00
- Document the ERROR level under the Log levels section. - Clarify documentation related to logging with the ERROR level when `--exit-on-error` is enabled. - Explain that TRY/EXCEPT cannot catch errors stopping the whole execution. Fixes #5424.
diff --git a/doc/userguide/src/CreatingTestData/ControlStructures.rst b/doc/userguide/src/CreatingTestData/ControlStructures.rst
@@ -1040,7 +1040,12 @@ they also mostly work the same way. A difference is that Python uses lower case
 upper case letters. A bigger difference is that with Python exceptions are objects
 and with Robot Framework you are dealing with error messages as strings.
 
+.. note:: It is not possible to catch errors caused by invalid syntax or errors
+          that `stop the whole execution`__.
+
+
 __ https://docs.python.org/tutorial/errors.html#handling-exceptions
+__ `Stopping test execution gracefully`_
 
 Catching exceptions with `EXCEPT`
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -1117,8 +1122,6 @@ other `EXCEPT` branches:
             Error Handler 2
         END
 
-.. note:: It is not possible to catch exceptions caused by invalid syntax.
-
 Matching errors using patterns
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
diff --git a/doc/userguide/src/ExecutingTestCases/OutputFiles.rst b/doc/userguide/src/ExecutingTestCases/OutputFiles.rst
@@ -268,10 +268,16 @@ log levels are:
 `FAIL`
    Used when a keyword fails. Can be used only by Robot Framework itself.
 
+`ERROR`
+   Used for displaying errors. Errors are shown in `the console and in
+   the Test Execution Errors section in log files`__, but they
+   do not affect test case statuses. If the `--exitonerror option is enabled`__,
+   errors stop the whole execution, though,
+
 `WARN`
-   Used to display warnings. They shown also in `the console and in
+   Used for displaying warnings. Warnings are shown in `the console and in
    the Test Execution Errors section in log files`__, but they
-   do not affect the test case status.
+   do not affect test case statuses.
 
 `INFO`
    The default level for normal messages. By default,
@@ -289,6 +295,8 @@ log levels are:
 
 __ `Logging information`_
 __ `Errors and warnings during execution`_
+__ `Stopping on parsing or execution error`_
+__ `Errors and warnings during execution`_
 
 Setting log level
 ~~~~~~~~~~~~~~~~~
diff --git a/doc/userguide/src/ExecutingTestCases/TestExecution.rst b/doc/userguide/src/ExecutingTestCases/TestExecution.rst
@@ -692,10 +692,9 @@ fatal and execution stopped so that remaining tests are marked failed. With
 parsing errors encountered before execution even starts, this means that no
 tests are actually run.
 
-When this option is enabled, using `ERROR` level in logs, such as `Log` keyword
-from BuiltIn or Python's standard logging module, will also fail the execution.
-Additionally, the TRY/EXCEPT stucture does not catch log messages with `ERROR`
-level, even when :option:`--exitonerror` is used.
+.. note:: Also logging something with the `ERROR` `log level`_ is considered
+          an error and stops the execution if the :option:`--exitonerror` option
+          is used.
 
 __ `Errors and warnings during execution`_
 
