diff --git a/docs/evthandlers/outcome_logger.rst b/docs/evthandlers/outcome_logger.rst new file mode 100644 index 00000000..6d6053fb --- /dev/null +++ b/docs/evthandlers/outcome_logger.rst @@ -0,0 +1,46 @@ +Outcome Logger +============== + +.. note:: + + This document explains how to use **outcome logger** event handler. + +Synopsis +-------- + +.. code-block:: text + + outcome-logger: null + +Outcome logger is one of the simplest event handlers, used to summarise the outcome +of all constraints. + +Options +------- + +``prefix`` +^^^^^^^^^^ + + Prefix to the logging message text. Example: + + .. code-block:: yaml + :caption: Prefix example + + prefix: "Hello" + + +Example +------- + +.. code-block:: yaml + :caption: Setup example + + events: + # Capture all events + $/$/$/$: + + handlers: + outcome-logger + + outcome-logger: + prefix: "My constraints" diff --git a/docs/evthandlers/overview.rst b/docs/evthandlers/overview.rst index 7894bc58..7f07d32d 100644 --- a/docs/evthandlers/overview.rst +++ b/docs/evthandlers/overview.rst @@ -9,6 +9,7 @@ Event Handlers :maxdepth: 1 console_logger + outcome_logger Overview --------