-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update documentation for the outcome logger
- Loading branch information
Showing
2 changed files
with
47 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -9,6 +9,7 @@ Event Handlers | |
:maxdepth: 1 | ||
|
||
console_logger | ||
outcome_logger | ||
|
||
Overview | ||
-------- | ||
|