Skip to content

Commit

Permalink
Update documentation for the outcome logger
Browse files Browse the repository at this point in the history
  • Loading branch information
isbm committed Oct 22, 2024
1 parent 549ba91 commit a474760
Show file tree
Hide file tree
Showing 2 changed files with 47 additions and 0 deletions.
46 changes: 46 additions & 0 deletions docs/evthandlers/outcome_logger.rst
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"
1 change: 1 addition & 0 deletions docs/evthandlers/overview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ Event Handlers
:maxdepth: 1

console_logger
outcome_logger

Overview
--------
Expand Down

0 comments on commit a474760

Please sign in to comment.